5、Swagger

发布时间: 2024-05-15 11:36:15

Swagger 是一个规范和完整的框架，用于生成、描述调用可视化RESTful风格的web

可以自动生成完善的RESTful API文档 根据后台代码修改，同步更新，提供完成的测试页面来调试API

    <dependency>
        <groupId>io.springfox</groupId>
        <artifactId>springfox-swagger2</artifactId>
        <version>3.0.0</version>
    </dependency>
    <dependency>
        <groupId>io.springfox</groupId>
        <artifactId>springfox-swagger-ui</artifactId>
        <version>3.0.0</version>
    </dependency>
   

配置Swagger

/** * API 文档自动生成 测试页面自动生成 / @Configuration //告诉Spring容器 ，这是个配置类 @EnableSwagger2//启用Swagger2功能 public class SwaggerConfig { /* * 配置Swagger2 相关的bean */ public Docket CreateRestApi(){ return new Docket(DocumentationType.SWAGGER_2) .apiInfo(apiInfo()) .select() .apis(RequestHandlerSelectors.basePackage("com"))//com包下所有的API都交给Swagger2管理 .paths(PathSelectors.any()).build(); }

/**
 * 此处主要是API文档页面显示信息
 * @return
 */
private ApiInfo apiInfo(){
    return new ApiInfoBuilder()
            .title("演示项目API")//标题
            .description("演示项目")//描述
            .version("11.0")//版本
            .build();
}
   

} 如运行报错 把springboot版本改为 2.7.8

org.springframework.boot spring-boot-starter-parent 2.7.8

application.properties 中添加 spring.mvc.pathmatch.matching-strategy=ANT_PATH_MATCHER 生产环境不显示