swagger

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

使用swagger只需要按照它的规范去定义API接口以及接口相关信息，在通过swagger衍生出来的一系列项目和工具，就可以生成各种格式的接口文档，以及在线接口调试页面等。

Knife4j

knife4j是为java mvc框架集成swagger生成api文档的增强解决方案

knife4j使用方法：

1、导入knife4j的maven坐标

<dependency>
        <groupId>com.github.xiaoymin</groupId>
        <artifactId>knife4j-spring-boot-starter</artifactId>
        <version>3.0.2</version>
</dependency>

2、导入knife4j的相关配置类

3、设置静态资源，否则接口文档页面无法访问

@Configuration
@Slf4j
@EnableSwagger2
@EnableKnife4j
public class WebMvcConfig extends WebMvcConfigurationSupport {
    /**
     * 设置静态资源映射
     * @param registry
     */
    @Override
    protected void addResourceHandlers(ResourceHandlerRegistry registry) {
        log.info("开始进行静态资源映射！！！");
        //registry.addResourceHandler("/backend/**").addResourceLocations("classpath:/backend/");
        //registry.addResourceHandler("/front/**").addResourceLocations("classpath:/front/");
        registry.addResourceHandler("doc.html").addResourceLocations("classpath:/META-INF/resources/");
        registry.addResourceHandler("/webjars/**").addResourceLocations("classpath:/META-INF/resources/webjars/");


    }
    /**
     * 创建接口文档对象
     * @return Docket：文档对象
     */
    @Bean
    public Docket creatRestApi(){
        //文档类型swagger2
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                //请求处理扫描器，扫描controller包内的所有方法生成Api接口文档
                .apis(RequestHandlerSelectors.basePackage("controller包路径"))
                //路径扫描器：any（）扫描所有路径
                .paths(PathSelectors.any())
                .build();
    }
    //创建api信息对象
    private ApiInfo apiInfo(){
        return new ApiInfoBuilder()
                .title("标题")
                .version("1.0")
                .description("文档描述")
                .build();
    }

4、设置不需要处理的请求路径(跳过登录过滤器)

“/doc.html”,
“/webjars/**”,
“/swagger-resources”,
“/v2/api-docs”

5、文档展示页面

http://localhost:8080/doc.htm

swagger常用注解

@Api    			用于controller类，表示对controller类的说明
@ApiModel			用于实体类，表示一个返回相应数据的信息
@ApiModelProperty	用于实体类属性，描述相应类的属性
@ApiOperation 		用于请求方法，说明方法用途和作用
@ApiImplicitParams	用于请求方法上，表示一族参数说明
@ApiImplicitParam	用于@ApiImplicitParams注解中，指定一个请求参数的各个方面