Swagger——团队API文档和设计工具

什么是Swagger

使用Swagger你只需要按照它的规范去定义接口及接口相关的信息，就可以做到生成接口文档，以及在线接口调试页面。

依赖：

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

使用方式

1. 导入 knife4j 的maven坐标
2. 在配置类中加入 knife4j 相关配置
3. 设置静态资源映射，否则接口文档无法访问
   WebMvcConfiguration:

@Configuration  
public class WebMvcConfig {  
    @Bean  
    public Docket docket() {  
        ApiInfo apiInfo = new ApiInfoBuilder()  
                .title("苍穹外卖项目接口文档")  
                .version("2.0")  
                .description("苍穹外卖项目接口文档")  
                .build();  
        Docket docket = new Docket(DocumentationType.SWAGGER_2)  
                .apiInfo(apiInfo)  
                .select()  
                // 指定生成接口需要扫描的包  
                .apis(RequestHandlerSelectors.basePackage("com.sky.controller"))  
                .paths(PathSelectors.any())  
                .build();  
        return docket;  
    }  
  
    protected void addResourceHandlers(ResourceHandlerRegistry registry) {  
        registry.addResourceHandler("/doc.html").addResourceLocations("classpath:/META-INF/resources/");  
        registry.addResourceHandler("/webjar/**").addResourceLocations("classpath:/META-INF/resources/webjars");  
    }  
  
}

常用注解

通过注解可以控制生成的接口文档，使接口文档拥有更好的可读性，常用注解如下：