1.新建Springboot项目
2.导入依赖
<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>
3.编写SwaggerController.java
@RestController
@Api("Swagger测试Controller")
public class SwaggerController {
@GetMapping("/admin")
@ApiOperation("管理员")
public String admin() {
return "admin success!";
}
@GetMapping("/update")
@ApiOperation("更新")
public String update() {
return "update success!";
}
@GetMapping("/add")
@ApiOperation("添加")
public String add() {
return "add success!";
}
@GetMapping("/delete")
@ApiOperation("删除")
public String delete() {
return "delete success!";
}
@GetMapping("/details")
@ApiOperation("详情")
public String detais() {
return "details success!";
}
@GetMapping("/export")
@ApiOperation("导出")
public String export() {
return "export success!";
}
}
4.编写SwaggerConfig.java
@Configuration
@EnableSwagger2
public class SwaggerConfig {
@Bean
public Docket createRestApi() {
return new Docket(DocumentationType.SWAGGER_2)
.apiInfo(apiInfo())
.select()
// 为当前包路径
.apis(RequestHandlerSelectors.basePackage("com.wantl.controller"))
.build();
}
// 构建 api文档的详细信息函数,注意这里的注解引用的是哪个
private ApiInfo apiInfo() {
return new ApiInfoBuilder()
// 页面标题
.title("Spring Boot 测试使用 Swagger2 构建RESTful API")
// 创建人信息
.contact(new Contact("Wantl", "https://blog.csdn.net/m0_46365614?spm=1011.2124.3001.5343", "1041370063@qq.com"))
// 版本号
.version("1.0")
// 描述
.description("API 描述")
.build();
}
}
5.启动项目,输入http://localhost:8080/swagger-ui.html
附:swagger2注解详解
@Api:用在请求的类上,表示对类的说明
tags="说明该类的作用,可以在UI界面上看到的注解"
value="该参数没什么意义,在UI界面上也看到,所以不需要配置"
@ApiOperation:用在请求的方法上,说明方法的用途、作用
value="说明方法的用途、作用"
notes="方法的备注说明"
@ApiImplicitParams:用在请求的方法上,表示一组参数说明
@ApiImplicitParam:用在@ApiImplicitParams注解中,指定一个请求参数的各个方面
name:参数名
value:参数的汉字说明、解释
required:参数是否必须传
paramType:参数放在哪个地方
· header --> 请求参数的获取:@RequestHeader
· query --> 请求参数的获取:@RequestParam
· path(用于restful接口)--> 请求参数的获取:@PathVariable
· body(不常用)
· form(不常用)
dataType:参数类型,默认String,其它值dataType="Integer"
defaultValue:参数的默认值
@ApiResponses:用在请求的方法上,表示一组响应
@ApiResponse:用在@ApiResponses中,一般用于表达一个错误的响应信息
code:数字,例如400
message:信息,例如"请求参数没填好"
response:抛出异常的类
@ApiModel:用于响应类上,表示一个返回响应数据的信息
(这种一般用在post创建的时候,使用@RequestBody这样的场景,请求参数无法使用@ApiImplicitParam注解进行描述的时候)
@ApiModelProperty:用在属性上,描述响应类的属性