Swagger总结

最新推荐文章于 2022-09-08 12:17:36 发布

风不会停息_H

最新推荐文章于 2022-09-08 12:17:36 发布

阅读量273

点赞数

分类专栏： java

本文链接：https://blog.csdn.net/he13733625052/article/details/113185326

版权

java 专栏收录该内容

18 篇文章 1 订阅

订阅专栏

号称世界上最流行的API框架
Restful Api 文档在线自动生成器 => API 文档与API 定义同步更新
直接运行，在线测试API
支持多种语言（如：Java，PHP等）
官网：https://swagger.io/

SpringBoot集成Swagger

要求Jdk1.8（否则无法运行）+Swagger2

步骤

1.添加Maven依赖

<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>

2.编写Swagger配置类

@Controller
@Configuration
@EnableSwagger2
publicclassSwaggerConfig{
@Bean
publicDocketdocket(Environmentenvironment){
//设置要显示的Swagger环境
Profilesprofiles=Profiles.of("dev","text");

booleanflag=environment.acceptsProfiles(profiles);


returnnewDocket(DocumentationType.SWAGGER_2)
.apiInfo(apiInfo())
//是否启用
.enable(flag)
.select()
//RequestHandlerSelectors配置要扫描的接口得方式
//any()全部扫描
//none()都不扫描
//basePackage()只扫描某个包里的一般情况下用这个
//withClassAnnotation（）扫描类上的注解
//withMethodAnnotation（）扫描方法上的注解
.apis(RequestHandlerSelectors.basePackage("com.dragon.controller"))
//过滤路径
//.paths(PathSelectors.ant(""))
.build();
}
publicApiInfoapiInfo(){
Contactcontact=newContact("贺义龙","","");
returnnewApiInfo("Dragon得Swagger博客",
"是骡子是马，牵出来遛遛",
"1.0",
"urn:tos",
contact,
"Apache2.0",
"http://www.apache.org/licenses/LICENSE-2.0",
newArrayList());

}

}

在Controller层中可以设置swagger提供的注解来解释接口的作用

@Api注解可以用来标记当前Controller的功能。
@ApiOperation注解用来标记一个方法的作用。
@ApiImplicitParam注解用来描述一个参数，可以配置参数的中文含义，也可以给参数设置默认值，这样在接口测试的时候可以避免手动输入。
如果有多个参数，则需要使用多个@ApiImplicitParam注解来描述，多个@ApiImplicitParam注解需要放在一个@ApiImplicitParams注解中。
需要注意的是，@ApiImplicitParam注解中虽然可以指定参数是必填的，但是却不能代替@RequestParam(required = true)，前者的必填只是在Swagger2框架内必填，抛弃了Swagger2，这个限制就没用了，所以假如开发者需要指定一个参数必填，@RequestParam(required = true)注解还是不能省略。