Swagger介绍

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

• 使得前后端分离开发更加方便，有利于团队协作。
• 接口的文档在线自动生成，降低后端开发人员编写接口文档的负担。
• 功能测试。

Knife4j

knife4j 是为 Java MVC 框架集成 Swagger 生成 Api 文档的增强解决方案。目前，SpringBoot一般使用 knife4j 来集成 Swagger。

使用步骤

导入 knife4j 的 maven 坐标

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

在配置类中加入 Knife4j 相关配置

@Bean
public Docket docket() {
    ApiInfo apiInfo = new ApiInfoBuilder()
            .title("XXX接口文档")
            .version("xx.xx.xx")
            .description("XXX接口文档")
            .build();
    Docket docket = new Docket(DocumentationType.SWAGGER_2)
            .apiInfo(apiInfo)
            .select()
            //指定生成接口需要扫描的包
            .apis(RequestHandlerSelectors.basePackage("要扫描的包路径"))
            .paths(PathSelectors.any())
            .build();
    return docket;
}

设置静态资源映射

此方法放在相同配置类下

protected void addResourceHandlers(ResourceHandlerRegistry registry) {
        registry.addResourceHandler("/doc.html").addResourceLocations("classpath:/META-INF/resources/");
        registry.addResourceHandler("/webjars/**").addResourceLocations("classpath:/META-INF/resources/webjars/");
}

访问测试

接口文档访问路径为 http://ip:port/doc.html

• ip：机器地址。
• port：端口。

常用注解