Spring Boot2配置Swagger2生成API接口文檔詳情

更新時間：2022年09月15日 14:09:02 作者：小二上酒8???????

這篇文章主要介紹了Spring Boot2配置Swagger2生成API接口文檔詳情，文章圍繞主題展開詳細(xì)的內(nèi)容介紹，具有一定的參考價值，需要的小伙伴可以參考一下

一、Swagger2介紹

前后端分離開發(fā)模式中，api文檔是最好的溝通方式。

Swagger 是一個規(guī)范和完整的框架，用于生成、描述、調(diào)用和可視化 RESTful 風(fēng)格的 Web 服務(wù)。

及時性(接口變更后，能夠及時準(zhǔn)確地通知相關(guān)前后端開發(fā)人員)
規(guī)范性(并且保證接口的規(guī)范性，如接口的地址，請求方式，參數(shù)及響應(yīng)格式和錯誤信息)
一致性(接口信息一致，不會出現(xiàn)因開發(fā)人員拿到的文檔版本不一致，而出現(xiàn)分歧)
可測性(直接在接口文檔上進(jìn)行測試，以方便理解業(yè)務(wù))

二、配置Swagger2

1、引入相關(guān)依賴

<!--swagger-->
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>2.7.0</version>
</dependency>
<!--swagger ui-->
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version>2.7.0</version>
</dependency>

2、創(chuàng)建swagger的配置類

@Configuration
@EnableSwagger2
public class SwaggerConfig {

@Bean
public Docket webApiConfig(){
return new Docket(DocumentationType.SWAGGER_2)
.groupName("webApi")
.apiInfo(webApiInfo())
.select()
.paths(Predicates.not(PathSelectors.regex("/admin/.*")))
.paths(Predicates.not(PathSelectors.regex("/error.*")))
.build();

}

private ApiInfo webApiInfo(){
return new ApiInfoBuilder()
.title("XX平臺API文檔")
.description("本文檔描述了xxx接口定義")
.version("1.0")
// 創(chuàng)建人
.contact(new Contact("Jade", "http://jade.com", "55317362@qq.com"))
.build();
}
}

3、在啟動類上添加注解掃描swagger的配置類，進(jìn)行測試

要能掃描到swagger的配置類SwaggerConfig

@SpringBootApplication
// 要能掃描到swagger的配置類SwaggerConfig
@ComponentScan(basePackages = {"com.jade"})
public class Application {
public static void main(String[] args) {
SpringApplication.run(Application.class, args);
}
}

4、API模型

可以添加一些自定義設(shè)置，例如：

定義樣例數(shù)據(jù)

@ApiModelProperty(value = "創(chuàng)建時間", example = "2019-01-01 8:00:00")
@TableField(fill = FieldFill.INSERT)
private Date gmtCreate;

@ApiModelProperty(value = "更新時間", example = "2019-01-01 8:00:00")
@TableField(fill = FieldFill.INSERT_UPDATE)
private Date gmtModified;

5、定義接口說明和參數(shù)說明

定義在類上：@Api
定義在方法上：@ApiOperation
定義在參數(shù)上：@ApiParam

@Api(description="講師管理")
@RestController
@RequestMapping("/admin/edu/teacher")
public class TeacherAdminController {

@Autowired
private TeacherService teacherService;

@ApiOperation(value = "所有講師列表")
@GetMapping
public List<Teacher> list(){
return teacherService.list(null);
}

@ApiOperation(value = "根據(jù)ID刪除講師")
@DeleteMapping("{id}")
public boolean removeById(
@ApiParam(name = "id", value = "講師ID", required = true)
@PathVariable String id){
return teacherService.removeById(id);
}
}