springboot 返回swagger 测试数据（SpingBoot整合Swagger告别维护api文档）
springboot 返回swagger 测试数据（SpingBoot整合Swagger告别维护api文档）@Api：用在请求的类上，表示对类的说明 tags="说明该类的作用，可以在UI界面上看到的注解" value="该参数没什么意义，在UI界面上也看到，所以不需要配置" @ApiOperation：用在请求的方法上，说明方法的用途、作用 value="说明方法的用途、作用" notes="方法的备注说明" @ApiImplicitParams：用在请求的方法上，表示一组参数说明 @ApiImplicitParam：用在@ApiImplicitParams注解中，指定一个请求参数的各个方面 name：参数名 value：参数的汉字说明、解释 required：参数是否必须传 paramType：参数放在哪个地方 · header --> 请求参数的获取：@RequestHeader
在前后端分离的时代，接口文档便成为了前端与后端的沟通桥梁，如果都通过手写文档去维护，工作量可不小，于是便有了Swagger这样的工具帮我们完成了这件事，我们只需要在写代码的时候使用Java注解就可以一键生成接口文档，是不是特别方便。今天就来讲讲如何使用springboot整合进Swagger帮我们生成接口文档。
第一步：首先我们需要创建一个SpringBoot项目
第二步：导入maven仓库，打开项目的pom.xml文件添加如下内容
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-boot-starter</artifactId>
<version>3.0.0</version>
</dependency>
第三部：配置Swagger，新建一个配置类Swagger3Config，代码如下：
@Configuration
public class Swagger3Config {
@Bean
public Docket createRestApi() {
return new Docket(DocumentationType.OAS_30)
.apiInfo(apiInfo())
.select()
.apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class))
.paths(PathSelectors.any())
.build();
}
private ApiInfo apiInfo() {
return new ApiInfoBuilder()
.title("Swagger3接口文档")
.description("更多请咨询服务开发者Ray。")
.contact(new Contact("KEXUN" "http://www.kexunsoftware.com" "1813723783@qq.com"))
.version("1.0")
.build();
}
}
启动类开启Swagger支持 @EnableOpenApi
@EnableOpenApi
@SpringBootApplication
@MapperScan(basePackages = {"cn.kexunsoft.mapper"})
public class ApiApplication {
public static void main(String[] args) {
SpringApplication.run(ApiApplication.class args);
}
}
到此为止Swagger的基本配置就完成啦，让我们创建一个Controller类来测试一下
@Api(tags = "测试接口")
@RestController
@RequestMapping("test")
public class TestApi {
@ApiOperation("测试方法")
@GetMapping("testMethod")
public String testMethod(@ApiParam("测试参数") String testParam) {
return "Hello";
}
}
启动项目访问： http://127.0.0.1:端口/项目的context-path/swagger-ui/ 如下图：
附swagger常用注解：
@Api：用在请求的类上，表示对类的说明
tags="说明该类的作用，可以在UI界面上看到的注解"
value="该参数没什么意义，在UI界面上也看到，所以不需要配置"
@ApiOperation：用在请求的方法上，说明方法的用途、作用
value="说明方法的用途、作用"
notes="方法的备注说明"
@ApiImplicitParams：用在请求的方法上，表示一组参数说明
@ApiImplicitParam：用在@ApiImplicitParams注解中，指定一个请求参数的各个方面
name：参数名
value：参数的汉字说明、解释
required：参数是否必须传
paramType：参数放在哪个地方
· header --> 请求参数的获取：@RequestHeader
· query --> 请求参数的获取：@RequestParam
· path（用于restful接口）--> 请求参数的获取：@PathVariable
· div（不常用）
· form（不常用）
dataType：参数类型，默认String，其它值dataType="Integer"
defaultValue：参数的默认值
@ApiResponses：用在请求的方法上，表示一组响应
@ApiResponse：用在@ApiResponses中，一般用于表达一个错误的响应信息
code：数字，例如400
message：信息，例如"请求参数没填好"
response：抛出异常的类
@ApiModel：用于model类上，表示一个实体的数据信息（这种一般用在post创建的时候，使用@RequestBody这样的场景，请求参数无法使用@ApiImplicitParam注解进行描述的时候）
description="描述实体的作用"
@ApiModelProperty：用在属性上，描述实体类的属性
value="用户名" 描述参数的意义
name="name" 参数的变量名
required=true 参数是否必选
@ApiParam:用在请求方法的参数上 表名参数的作用
name="参数名称"
value="参数的简要说明"
defaultValue="参数默认值"
required="true" 表示属性是否必填，默认为false
@ApiIgnore()：用于类或者方法上，不被显示在页面上
@Profile({"dev" "test"})：用于配置类上，表示只对开发和测试环境有用
好啦，本文就到此结束啦，如果有任何疑问或者建议欢迎在下方评论区留言哦，同时欢迎大家关注我的微信公众号【程序员MuziDong】，第一时间获取最新动态。
