Swagger框架-接口开发文档

Knife4j

Knife4j是一款可以提供在线API文档的框架，是基于Swagger框架实现的。

在Spring Boot项目中，使用Knife4j需要添加依赖knife4j-spring-boot-starter：

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

然后，需要添加配置Knife4jConfig类：

@Configuration
@EnableSwagger2WebMvc
public class Knife4jConfig {

    /**
     * 【重要】指定Controller包路径
     */
    private String basePackage = "cn.tedu.boot.demo.controller";
    /**
     * 分组名称
     */
    private String groupName = "product";
    /**
     * 主机名
     */
    private String host = "http://java.tedu.cn";
    /**
     * 标题
     */
    private String title = "酷鲨商城在线API文档--商品管理";
    /**
     * 简介
     */
    private String description = "酷鲨商城在线API文档--商品管理";
    /**
     * 服务条款URL
     */
    private String termsOfServiceUrl = "http://www.apache.org/licenses/LICENSE-2.0";
    /**
     * 联系人
     */
    private String contactName = "Java教学研发部";
    /**
     * 联系网址
     */
    private String contactUrl = "http://java.tedu.cn";
    /**
     * 联系邮箱
     */
    private String contactEmail = "java@tedu.cn";
    /**
     * 版本号
     */
    private String version = "1.0.0";

    @Autowired
    private OpenApiExtensionResolver openApiExtensionResolver;

    @Bean
    public Docket docket() {
        String groupName = "1.0.0";
        Docket docket = new Docket(DocumentationType.SWAGGER_2)
                .host(host)
                .apiInfo(apiInfo())
                .groupName(groupName)
                .select()
                .apis(RequestHandlerSelectors.basePackage(basePackage))
                .paths(PathSelectors.any())
                .build()
                .extensions(openApiExtensionResolver.buildExtensions(groupName));
        return docket;
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title(title)
                .description(description)
                .termsOfServiceUrl(termsOfServiceUrl)
                .contact(new Contact(contactName, contactUrl, contactEmail))
                .version(version)
                .build();
    }

}

注意：必须修改以上配置中的包名，保证是当前项目中控制器类所在的包！其它各项均可不修改，以上配置代码可以从Knife4j的官网找到！

最后，还需要在配置文件中开启Knife4j的增强模式：

#Knife4j配置
knife4j:
  # 是否开启增强模式
  enable: true

完成后，启动项目，在浏览器中访问 http://localhost:8080/doc.html 即可查看当前项目的API文档。

在控制器类上添加@Api注解，并配置tags属性，可以指定模块名称，例如：

@Api(tags = "管理员管理模块")  // 新增
@RestController
@RequestMapping(value = "/admins", produces = "application/json;charset=utf-8")
public class AdminController {
    
    // ===== 原有其它代码 =====
    
}

在处理请求的方法上添加@ApiOperation注解可以配置业务名称，例如：

@ApiOperation("管理员登录") // 新增
@PostMapping("/login")
public JsonResult<AdminSimpleVO> login(@Validated AdminLoginDTO adminLoginDTO) {
    AdminSimpleVO adminSimpleVO = adminService.login(adminLoginDTO);
    return JsonResult.ok(adminSimpleVO);
}

当需要指定各业务在API文档中的显示顺序时，可以在处理请求的方法上添加@ApiOperationSupport注解，配置此注解的order属性，最终在显示API文档时，会根据order属性值升序排列，例如：

@ApiOperation("管理员登录")
@ApiOperationSupport(order = 900) // 新增
@PostMapping("/login")
public JsonResult<AdminSimpleVO> login(@Validated AdminLoginDTO adminLoginDTO) {
    AdminSimpleVO adminSimpleVO = adminService.login(adminLoginDTO);
    return JsonResult.ok(adminSimpleVO);
}

通常，建议以上配置的order值至少是2位的数字，并且有预留位置，例如10_{19之间的都是增加数据的业务，20}29之间的都是删除数据的业务，30_{39之间都是修改数据的业务，40}49之间都是查询数据的业务。