Swagger(SpringBoot集成Swagger 常用Swagger注解)

目录

一、导语

二、Swagger是什么?它能干什么?

作用:

三、SpringBoot集成Swagger  

1. 初始实现步骤

1.1 添加Maven依赖

1.2 编写HelloController,测试确保运行成功

1.3 编写一个配置类-SwaggerConfig来配置 Swagger

1.4 访问测试 :http://localhost:8080/swagger-ui.html ,可以看到swagger的界面;

2. 配置Swagger

2.1 Swagger实例Bean是Docket,所以通过配置Docket实例来配置Swagger

2.2 可以通过apiInfo()属性配置文档信息

2.3 Docket 实例关联上 apiInfo()

2.4 重启项目,访问测试 http://localhost:8080/swagger-ui.html 看下效果; 

3. 配置扫描接口  

3.1 构建Docket时通过select()方法配置怎么扫描接口

3.2 重启项目测试,由于我们配置根据包的路径扫描接口,所以我们只能看到一个类

3.3 除了通过包路径配置扫描接口外,还可以通过配置其他方式扫描接口,这里注释一下所有的配置方式

3.4 除此之外,我们还可以配置接口扫描过滤

3.5 这里的可选值还有

4. 配置API分组

4.1 如果没有配置分组,默认是default。通过groupName()方法即可配置分组

4.2 重启项目查看分组

4.3 如何配置多个分组?配置多个分组只需要配置多个docket即可:

5. 拓展:其他皮肤

四、常用Swagger注解

@Api

@ApiOperation

@ApiImplicitParam

@ApiImplicitParams

@ApiParam

@ApiResponse

@ApiResponses

@ApiModel

@ApiModelProperty

@ApiIgnore

@ApiError

演示


一、导语

        相信无论是前端还是后端开发,都或多或少地被接口文档折磨过。前端经常抱怨后端给的接口文档与实际情况不一致。后端又觉得编写及维护接口文档会耗费不少精力,经常来不及更新。其实无论是前端调用后端,还是后端调用后端,都期望有一个好的接口文档。但是这个接口文档对于程序员来说,就跟注释一样,经常会抱怨别人写的代码没有写注释,然而自己写起代码起来,最讨厌的,也是写注释。所以仅仅只通过强制来规范大家是不够的,随着时间推移,版本迭代,接口文档往往很容易就跟不上代码了

二、Swagger是什么?它能干什么?

官方网址https://swagger.io/        

        发现了痛点就要去找解决方案。解决方案用的人多了,就成了标准的规范,这就是Swagger 的由来。通过这套规范,你只需要按照它的规范去定义接口及接口相关的信息。再通过Swagger 衍生出来的一系列项目和工具,就可以做到生成各种格式的接口文档 生成多种语言的客户端和服务端的代码,以及在线 接口调试页面等等 。这样,如果按照新的开发模式,在开发新版本或者迭代版本的时候,只需要更新Swagger描述文件,就可以自动生成接口文档和客户端服务端代码,做到调用端代码、服务端代码以及接口文档的一致性。
框架说明
现在SWAGGER官网主要提供了几种开源工具,提供相应的功能。可以通过配置甚至是修改源码以达到你想要的效果

作用:

  • 1. 接口的文档在线自动生成
  • 2. 功能测试

三、SpringBoot集成Swagger  

1. 初始实现步骤

1.1 添加Maven依赖

        <dependency>
            <groupId>com.github.xiaoymin</groupId>
            <artifactId>swagger-bootstrap-ui</artifactId>
            <version>1.9.1</version>
        </dependency>
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>2.9.2</version>
        </dependency>
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>2.9.2</version>
        </dependency>

1.2 编写HelloController,测试确保运行成功

@RestController
public class HelloController {

    @RequestMapping("/hello")
    public String hello(){
        return "helloWorld";
    }

}

1.3 编写一个配置类-SwaggerConfig来配置 Swagger

@Configuration//配置类
@EnableSwagger2// 开启Swagger2的自动配置
public class SwaggerConfig {
}

1.4 访问测试 :http://localhost:8080/swagger-ui.html ,可以看到swagger的界面;

如果启动报错空指针是因为springboot2.6.0中将SpringMVC 默认路径匹配策略从AntPathMatcher 更 改为PathPatternParser,导致出错
可以在启动类上加上@EnableWebMvc注解或者在配置中切换为原先的AntPathMatcher(加注解不太行)
spring.mvc.pathmatch.matching-strategy=ant_path_matcher

2. 配置Swagger

2.1 Swagger实例BeanDocket,所以通过配置Docket实例来配置Swagger

@Bean //配置docket以配置Swagger具体参数
    public Docket docket() {
        return new Docket(DocumentationType.SWAGGER_2);
    }

2.2 可以通过apiInfo()属性配置文档信息

 //配置文档信息
    private ApiInfo apiInfo() {
        Contact contact = new Contact("联系人名字", "http://xxx.xxx.com/联系人访问链接", "联系人邮箱");
        return new ApiInfo(
                "Swagger学习", // 标题
                "学习演示如何配置Swagger", // 描述
                "v2.0", // 版本
                "http://zkt .com", // 组织链接
                contact, // 联系人信息
                "Apach 2.0 许可", // 许可
                "许可链接", // 许可连接
                new ArrayList<>()// 扩展
        );
    }

2.3 Docket 实例关联上 apiInfo()

 @Bean //配置docket以配置Swagger具体参数
    public Docket docket() {
        return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo());
    }

2.4 重启项目,访问测试 http://localhost:8080/swagger-ui.html 看下效果; 

3. 配置扫描接口  

3.1 构建Docket时通过select()方法配置怎么扫描接口

 @Bean //配置docket以配置Swagger具体参数
    public Docket docket() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .groupName("hello") // 配置分组
                .select()// 通过.select()方法,去配置扫描接口,RequestHandlerSelectors配置如何扫描接口
                .apis(RequestHandlerSelectors.basePackage("com.zkt.springboot_swagger01.controller"))
                .paths(PathSelectors.any())
                .build();
    }

3.2 重启项目测试,由于我们配置根据包的路径扫描接口,所以我们只能看到一个类

3.3 除了通过包路径配置扫描接口外,还可以通过配置其他方式扫描接口,这里注释一下所有的配置方式

any() // 扫描所有,项目中的所有接口都会被扫描到
none() // 不扫描接口
// 通过方法上的注解扫描,如withMethodAnnotation(GetMapping.class)只扫描get请求
withMethodAnnotation(final Class<? extends Annotation> annotation)
// 通过类上的注解扫描,如.withClassAnnotation(Controller.class)只扫描有controller注解
的类中的接口
withClassAnnotation(final Class<? extends Annotation> annotation)
basePackage(final String basePackage) // 根据包路径扫描接口

3.4 除此之外,我们还可以配置接口扫描过滤

@Bean
public Docket docket() {
    return new Docket(DocumentationType.SWAGGER_2)
        .apiInfo(apiInfo())
        .select() // 通过.select()方法,去配置扫描接口, RequestHandlerSelectors配置如何扫
                  // 描接口
        .apis(RequestHandlerSelectors.basePackage("com.zkt.swagger.controller"))
        // 配置如何通过path过滤,即这里只扫描请求以/zkt开头的接口
        .paths(PathSelectors.ant("/zkt/**"))
        .build();
}

3.5 这里的可选值还有

any() // 任何请求都扫描
none() // 任何请求都不扫描
regex(final String pathRegex) // 通过正则表达式控制
ant(final String antPattern) // 通过ant()控制

4. 配置API分组

4.1 如果没有配置分组,默认是default。通过groupName()方法即可配置分组

4.2 重启项目查看分组

4.3 如何配置多个分组?配置多个分组只需要配置多个docket即可:

​
 @Bean
    public Docket docket1(){
        return new Docket(DocumentationType.SWAGGER_2).groupName("group1");
    }
    @Bean
    public Docket docket2(){
        return new Docket(DocumentationType.SWAGGER_2).groupName("group2");
    }
    @Bean
    public Docket docket3(){
        return new Docket(DocumentationType.SWAGGER_2).groupName("group3");
    }

​

5. 拓展:其他皮肤

我们可以导入不同的包实现不同的皮肤定义
1. 默认的访问 http://localhost:8080/swagger-ui.html
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version>2.9.2</version>
</dependency>
2.bootstrap-ui 访问 http://localhost:8080/doc.html
        <dependency>
            <groupId>com.github.xiaoymin</groupId>
            <artifactId>swagger-bootstrap-ui</artifactId>
            <version>1.9.1</version>
        </dependency>

四、常用Swagger注解

Swagger通过注解生成接口文档,包括接口名、请求方法、参数、返回信息等等。

@Api

修饰整个类,描述Controller的作用

语法:@Api(tag="类的作用,可以在UI界面上看到的注释", value="/类的访问路径", description="类的文字描述")

@ApiOperation

描述一个类的一个方法,说明方法的作用

语法:@ApiOperation(value="接口名称", httpMethod="接口请求方式", response="接口返回 参数类型", notes="接口发布说明")

@ApiImplicitParam

一个请求参数

语法:@ApiImplicitParam(required="是否必须参数", name="参数名称", value="参数具体描述", dataType="变量类型", paramType="请求方式" )

  • header -> 请求参数的获取:@RequestHeader
  • query -> 请求参数的获取:@RequestParam
  • path(用于restful接口)-> 请求参数的获取:@PathVariable
  • body(不常用) -> 请求参数的获取:@RequestBody
  • form(不常用) -> 请求参数的获取:@RequestParam

@ApiImplicitParams

多个请求参数

@ApiParam

单个参数描述

语法:@ApiParam(required="是否必须参数", name="参数名称", value="参数具体描述",dataType="变量类型",paramType="请求方式")

@ApiResponse

HTTP响应应答描述

语法:@ApiResponse(code=400, message="Invalid user supplied")

@ApiResponses

HTTP响应整体描述

语法:@ApiResponses({@ApiResponse(code=400, message="Invalid Order")})

@ApiModel

用对象实体类作为入参

@ApiModelProperty

用对象接收参数时,描述对象的一个字段

@ApiIgnore

使用该注解忽略这个API

@ApiError

发生错误返回的信息

演示

entity

import java.sql.Date;
/**
 * @author zkt
 * @Version 1.0
 * @since 2024/7/30
 */
@Data
@NoArgsConstructor
@AllArgsConstructor
@ApiModel(value = "管理员实体列1",description = "管理员实体类2")
public class Admin {
    @ApiModelProperty(name = "adminId",value = "管理员编号",example = "001")
    private int adminId;//管理员编号
    @ApiModelProperty(name = "adminLoginAccount",value = "管理员登录账号",example = "13991267980")
    private String adminLoginAccount;//管理员登录账号(手机号码)
    @ApiModelProperty(name = "adminLoginPassword",value = "登录登录密码",example = "123456")
    private String adminLoginPassword;//登录登录密码(默认为手机号码后8位)
    @ApiModelProperty(name = "adminRole",value = "管理员角色",example = "管理员")
    private String adminRole;//管理员角色(超级管理员或普通管理员)
    @ApiModelProperty(name = "adminLastLoginTime",value = "最后登录时间")
    private Date adminLastLoginTime;//最后登录时间(2024年07月30日 17:26:40)
}
/**
 * @author zkt
 * @Version 1.0
 * @since 2024/7/30
 */
//结果集
@Data
@NoArgsConstructor
@AllArgsConstructor
@ApiModel(value = "控制器方法返回值",description = "自定义结果集")
public class Result {
    @ApiModelProperty(name = "falge",value = "结果集状态",example = "true")
    private boolean falge;//状态
    @ApiModelProperty(name = "message",value = "提示信息",example = "查询成功")
    private String message;//提示信息
    @ApiModelProperty(name = "data",value = "返回数据")
    private Object data;//返回数据
}

config

/**
 * @author zkt
 * @Version 1.0
 * @since 2024/7/30
 */

/**
 * Swagger2配置类
 * 通过@Configuration注解,让Spring来加载该类配置。
 * 再通过@EnableSwagger2注解来启用Swagger2。
 */
@Configuration//配置类
//@EnableSwagger2// 开启Swagger2的自动配置
public class SwaggerConfig {

    /**
     * 创建API应用
     * apiInfo() 增加API相关信息
     * 通过select()函数返回一个ApiSelectorBuilder实例,用来控制哪些接口暴露给Swagger来展现,
     * 本例采用指定扫描的包路径来定义指定要建立API的目录。
     */
    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.zkt.springboot_swagger01.controller"))//扫描路径
                .paths(PathSelectors.any())//定义哪些路径的接口需要生成文档
                .build();
    }

    /**
     * 创建该API的基本信息(这些基本信息会展现在文档页面中)
     * 访问地址:http://项目实际地址/swagger-ui.html
     */
    private ApiInfo apiInfo() {
        Contact contact = new Contact("zkt", "http://www.zkt.com", "18709208653@163.com");
        return new ApiInfoBuilder()
                .title("疫情防控数据采集发布平台")//文档首页标题
                .version("1.0")//文档版本
                .description("新型冠状病毒肺炎 - 疫情防控数据采集发布平台后端接口说明文档")//文档描述信息
                .contact(contact)//创建者信息
                .build();
    }
}

controller

/**
 * @author zkt
 * @Version 1.0
 * @since 2024/7/30
 */
@RestController
@RequestMapping("/user")
@Api(tags = "UserController|一个用来测试swagger注解的控制器1", value = "/user")
public class UserController {
    /************************************修饰参数****************************************/
    @GetMapping(value = "/findByName")
    @ApiOperation(value = "根据用户名查询", notes = "描述的具体信息可以省略", httpMethod = "GET", response = Result.class)
    public Result findByName(@RequestParam String userName) {
        if (userName.equals("zkt")) {
            return new Result(true, "查询成功", "zkt");
        } else {
            return new Result(false, "查询失败", null);
        }
    }

    @GetMapping(value = "/findByNameAndSex")
    @ApiOperation(value = "根据用户名与性别查询", notes = "描述的具体信息可以省略")
    public Result findByNameAndSex(String userName, String sex) {
        if (userName.equals("zkt7")) {
            return new Result(true, "查询成功", "zkt7");
        } else {
            return new Result(false, "查询失败", null);
        }
    }

    @GetMapping(value = "/findByAge/{age}")
    @ApiOperation(value = "根据年龄查询", notes = "描述的具体信息可以省略")
    public Result findByAge(@PathVariable("age") Integer userAge) {
        if (userAge > 18) {
            return new Result(true, "查询成功", "zkt7");
        } else {
            return new Result(false, "查询失败", null);
        }
    }

    @PostMapping(value = "/saveAdmin1")
    @ApiOperation(value = "新增管理员信息1", notes = "描述的具体信息可以省略")
    public Result saveAdmin1(Admin admin) {
        if (admin.getAdminId() > 10) {
            return new Result(true, "查询成功", "zkt7");
        } else {
            return new Result(false, "查询失败", null);
        }
    }

    @PostMapping(value = "/saveAdmin2")
    @ApiOperation(value = "新增管理员信息2", notes = "描述的具体信息可以省略")
    public Result saveAdmin2(@RequestBody Admin admin) {
        if (admin.getAdminId() > 10) {
            return new Result(true, "查询成功", "zkt7");
        } else {
            return new Result(false, "查询失败", null);
        }
    }

    /************************************返回值****************************************/

    @DeleteMapping(value = "/deleteById/{id}")
    @ApiOperation(value = "根据用户编号删除信息", notes = "")
    public Admin deleteById(@PathVariable("id") Integer userId) {

        return new Admin(1, "张三", "张三", "张三", new Date(System.currentTimeMillis()));

    }
}

配置文件

启动类加上注解

可以进行测试

点击try it out 

主要看看新增

@RequestBody 通常用于将传入的 JSON 或 XML 数据映射到 Java 对象。        

  • 15
    点赞
  • 6
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 0
    评论
要在Spring Boot中集成Swagger,你需要做以下几个步骤: 1. 首先,确保你使用的是Spring Boot 2.5.x及之前的版本。因为从Spring Boot 2.6.x开始,Swagger已经从Spring Boot中移除了。 2. 在你的Spring Boot应用中添加Swagger的依赖。在pom.xml文件中,添加以下依赖: ```xml <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-boot-starter</artifactId> <version>3.0.0</version> </dependency> ``` 3. 在启动类上添加`@EnableSwagger2`注解。这个注解会启用Swagger的功能。你可以将这个注解直接添加到你的Spring Boot启动类上,或者创建一个单独的配置类,在配置类中添加这个注解。 4. 配置Swagger的相关属性。你可以在`application.properties`或`application.yml`文件中添加以下配置: ```yaml springfox.documentation.swagger.v2.path=/swagger springfox.documentation.swagger.ui.enabled=true ``` 这些配置将指定Swagger的路径和UI的启用状态。 5. 编写API文档。在你的控制器类中,使用Swagger注解来描述你的API接口。例如,你可以使用`@Api`注解来给你的控制器类添加一个API的描述,<span class="em">1</span><span class="em">2</span><span class="em">3</span> #### 引用[.reference_title] - *1* *2* *3* [SpringBoot教程(十六) | SpringBoot集成swagger(全网最全)](https://blog.csdn.net/lsqingfeng/article/details/123678701)[target="_blank" data-report-click={"spm":"1018.2226.3001.9630","extra":{"utm_source":"vip_chatgpt_common_search_pc_result","utm_medium":"distribute.pc_search_result.none-task-cask-2~all~insert_cask~default-1-null.142^v92^chatsearchT3_1"}}] [.reference_item style="max-width: 100%"] [ .reference_list ]
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

冯诺依曼转世

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值