SpringBoot整合Swagger3 1. 导⼊maven坐标
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-boot-starter</artifactId>
springboot原理是什么
<version>3.0.0</version>
</dependency>
2. 启动类上⾯加⼊@EnableOpenApi注解
3.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("简述")
.contact(new Contact("作者", "url", "邮箱"))
.version("版本")
.build();
}
}
4. 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：⽤于响应类上，表⽰⼀个返回响应数据的信息
（这种⼀般⽤在post创建的时候，使⽤@RequestBody这样的场景，
请求参数⽆法使⽤@ApiImplicitParam注解进⾏描述的时候）
@ApiModelProperty：⽤在属性上，描述响应类的属性
**Swagger的访问路径由swagger-ui.html改成了swagger-ui/ 或swagger-ui/index.html **

版权声明：本站内容均来自互联网，仅供演示用，请勿用于商业和其他非法用途。如果侵犯了您的权益请与我们联系QQ:729038198，我们将在24小时内删除。