SpringBoot整合Swagger3⽣成接⼝⽂档过程解析
  前后端分离的项⽬，接⼝⽂档的存在⼗分重要。与⼿动编写接⼝⽂档不同，swagger是⼀个⾃动⽣成接⼝⽂档的⼯具，在需求不断变更的环境下，⼿动编写⽂档的效率实在太低。与新版的swagger3相⽐swagger2配置更少，使⽤更加⽅便。
⼀、pom⽂件中引⼊Swagger3依赖
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-boot-starter</artifactId>
<version>3.0.0</version>
</dependency>
⼆、Application上⾯加⼊@EnableOpenApi注解
@EnableOpenApi
@SpringBootApplication
@MapperScan(basePackages = {"cn.ruiyeclub.dao"})
public class Swagger3Application {
public static void main(String[] args) {
SpringApplication.run(Swagger3Application.class, args);
}
}
三、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("Ray。", "www.ruiyeclub", "ruiyeclub@foxmail"))
.version("1.0")
.build();
}
}
四、Swagger注解的使⽤说明
@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：⽤在属性上，描述响应类的属性
Controller层的配置：
@Api(tags = "⽤户信息管理")
@RestController
@RequestMapping("userRecord")
public class UserRecordController extends ApiController {
/**
* 服务对象
*/
@Resource
private UserRecordService userRecordService;
/**
* 分页查询所有数据
* @param page    分页对象
* @param userRecord 查询实体
* @return 所有数据
*/
@ApiOperation("分页查询所有数据")
@GetMapping("page")
public R selectAll(Page<UserRecord> page, UserRecord userRecord) {
return success(this.userRecordService.page(page, new QueryWrapper<>(userRecord)));
}
/**
* 通过主键查询单条数据
* @param id 主键
* @return 单条数据
*/
@ApiOperation("通过主键查询单条数据")
@GetMapping("{id}")
public R selectOne(@PathVariable Serializable id) {
return success(ById(id));
}
/
**
* 新增数据
* @param userRecord 实体对象
* @return 新增结果
*/
@ApiOperation("新增数据")
@PostMapping("insert")
public R insert(@RequestBody UserRecord userRecord) {
return success(this.userRecordService.save(userRecord));
}
/**
* 修改数据
* @param userRecord 实体对象
* @return 修改结果
*/
@ApiOperation("修改数据")
@PutMapping("update")
public R update(@RequestBody UserRecord userRecord) {
return success(this.userRecordService.updateById(userRecord));
}
/**
* 删除数据
* @param idList 主键结合
* @return 删除结果
*/
@ApiOperation("删除数据")
@DeleteMapping("delete")
public R delete(@RequestParam("idList") List<Long> idList) {
return success(veByIds(idList));
}
}
五、Swagger界⾯效果
Swagger的访问路径由port/swagger-ui.html改成了port/swagger-ui/ 或port/swagger-ui/index.html，项⽬演⽰代码在以上就是本⽂的全部内容，希望对⼤家的学习有所帮助，也希望⼤家多多⽀持。

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