前后端分离的项目，接口文档的存在十分重要。与手动编写接口文档不同，swagger是一个自动生成接口文档的工具，在需求不断变更的环境下，手动编写文档的效率实在太低。与新版的swagger3相比swagger2配置更少，使用更加方便。
第一步 加入依赖
<!--Swagger3-->
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-boot-starter</artifactId>
<version>3.0.0</version>
</dependency>
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version>3.0.0</version>
</dependency>
其实用一个starter就可以了 但是我的maven无法下载其中的swagger-ui所以又加了一条依赖
第二步 配置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();
}
/**
* contact类的路径是springfox.documentation.service.Contact;
* @return
*/
private ApiInfo apiInfo() {
return new ApiInfoBuilder()
.title("Swagger3接口文档")
.description("更多请咨询服务开发者Ray。")
.contact(new Contact("Ray。", "http://www.ruiyeclub.cn", "[email protected]"))
.version("1.0")
.build();
}
}
第四步 加@EnableOpenApi注解
@SpringBootApplication
@EnableOpenApi
@MapperScan("com.swagger.demo.mapper")
public class SpringBootSwaggerTestApplication {
public static void main(String[] args) {
SpringApplication.run(SpringBootSwaggerTestApplication.class, args);
}
}
第五步 编写Html
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<title>Title</title>
</head>
<body>
<h1>hello world!</h1>
<a href="/swagger-ui/index.html">查看Api</a>
</body>
</html>
第六步 编写Controller
@Controller
@Api(tags = "欢迎页面")
public class HelloController {
@Autowired(required = false)
UserService userService;
@ApiOperation(value = "设置主页面",httpMethod="POST",notes="测试")
@RequestMapping("/")
public String index(){
return "hello";
}
@ApiOperation(value = "获取所有用户",httpMethod="POST",notes="测试")
@RequestMapping("/getAllUser")
@ResponseBody
public List<User> dataOfUser(){
return userService.findAll();
}
}
第七步 启动
在Url后面加上/swagger-ui/index.html
大功告成
然后就是常用的注解说明
@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：用在属性上，描述响应类的属性