swaggerAPI接口文档分组

最新推荐文章于 2024-08-13 16:33:53 发布

吾生有牙

最新推荐文章于 2024-08-13 16:33:53 发布

阅读量3.9k

点赞数 1

文章标签： java spring 接口

本文链接：https://blog.csdn.net/gfdgdshhg/article/details/104365154

版权

本文介绍了如何利用swagger的注解功能对后台API接口进行分组，以应对接口增多导致的查看不便问题。通过创建自定义注解和在配置类中设置Docket，实现了基于注解的接口分类，提高了接口管理的灵活性。但需注意groupName的唯一性和withMethodAnnotation方法对单个注解的限制。

摘要由CSDN通过智能技术生成

swagger是一个深度集成的后台API文档工具,极大的方便了后端的开发测试以及和前端的对接工作。但是当项目中的接口越来越多时，会导致页面上的接口过多，查看起来不是很方便，这时可以使用swagger的分组功能将接口进行分组分页展示。分组的规则可以基于路径和注解等，下面主要介绍下基于注解的分类，这种方法比较灵活。

先上结果

分组一

在这里插入图片描述
分组二

在这里插入图片描述

首先定义用于标志分组的注解
在这里插入图片描述
然后在swagger配置类里面创建多个Docket

代码如下

@Configuration
@EnableSwagger2
public class Swagger2 {
   
    @Bean
    public Docket createApi1() {
   
        return new Docket(DocumentationType.SWAGGER_2)
                .groupName("分组接口一")
                .apiInfo(apiInfo("分组接口一"))
                .select()
                .apis(RequestHandlerSelectors.withMethodAnnotation(SwaggerApi1.class))
                .paths(PathSelectors.any())
                .build()
                //全局权限验证
                .securitySchemes(securitySchemes())
                .securityContexts(securityContexts())
                ;
    }
    @Bean
    public Docket createApi2() {
   
        return new Docket(DocumentationType.SWAGGER_2)
                .groupName(