這篇文章主要講解了“如何使用Spring Boot集成Swagger”，文中的講解內(nèi)容簡(jiǎn)單清晰，易于學(xué)習(xí)與理解，下面請(qǐng)大家跟著小編的思路慢慢深入，一起來(lái)研究和學(xué)習(xí)“如何使用Spring Boot集成Swagger”吧！
成都創(chuàng)新互聯(lián)公司主營(yíng)元寶網(wǎng)站建設(shè)的網(wǎng)絡(luò)公司,主營(yíng)網(wǎng)站建設(shè)方案,成都app軟件開(kāi)發(fā)公司,元寶h5重慶小程序開(kāi)發(fā)公司搭建,元寶網(wǎng)站營(yíng)銷(xiāo)推廣歡迎元寶等地區(qū)企業(yè)咨詢(xún)
添加Maven坐標(biāo)
io.springfox springfox-swagger2 2.9.2 io.springfox springfox-swagger-ui 2.9.2
編寫(xiě)一個(gè)配置類(lèi)
重慶分公司
重慶分公司
@Configuration //配置類(lèi)
@EnableSwagger2// 開(kāi)啟Swagger2的自動(dòng)配置
public class SwaggerConfig {
@Bean
public Docket docket() {
// 設(shè)置要啟用Swagger的環(huán)境
Profiles profiles = Profiles.of("dev", "test");
// 判斷當(dāng)前是否處于該環(huán)境，通過(guò) enable() 接收此參數(shù)判斷是否要啟用Swagger
boolean flag = environment.acceptsProfiles(profiles);
return new Docket(DocumentationType.SWAGGER_2)
.groupName("group1")// 設(shè)置分組，方便多人協(xié)作開(kāi)發(fā)
.apiInfo(apiInfo())
.enable(flag)
.select()// 通過(guò).select()方法，去配置掃描接口，RequestHandlerSelectors配置如何掃描接口
.apis(RequestHandlerSelectors.basePackage("com.example.controller"))// basePackage 掃描指定包路徑下的接口。其他掃描方式可以點(diǎn)開(kāi)RequestHandlerSelectors的源碼查看
.build();
}
//配置文檔信息
private ApiInfo apiInfo() {
Contact contact = new Contact("聯(lián)系人名字", "http://xxx.xxx.com/聯(lián)系人訪(fǎng)問(wèn)鏈接", "聯(lián)系人郵箱");
return new ApiInfo(
// 標(biāo)題
"Swagger學(xué)習(xí)",
// 描述
"學(xué)習(xí)演示如何配置Swagger",
// 版本
"v1.0",
// 組織鏈接
"http://terms.service.url/組織鏈接",
// 聯(lián)系人信息
contact,
// 許可
" Apach 2.0 許可",
// 許可連接
"許可鏈接",
// 擴(kuò)展
new ArrayList<>()
);
}
}配置實(shí)體類(lèi)
@ApiModel("用戶(hù)實(shí)體")
public class User {
@ApiModelProperty("用戶(hù)名")
public String username;
@ApiModelProperty("密碼")
public String password;
}常用注解
@ApiOperation("xxx接口說(shuō)明")：作用在接口方法上
@ApiModel("xxxPOJO說(shuō)明")：作用在實(shí)體類(lèi)上
@ApiModelProperty(value = "xxx屬性說(shuō)明", hidden = true)：作用在實(shí)體類(lèi)的屬性上，hidden設(shè)置為true可以隱藏該屬性
@ApiParam("xxx參數(shù)說(shuō)明")：作用在接口方法的參數(shù)上
感謝各位的閱讀，以上就是“如何使用Spring Boot集成Swagger”的內(nèi)容了，經(jīng)過(guò)本文的學(xué)習(xí)后，相信大家對(duì)如何使用Spring Boot集成Swagger這一問(wèn)題有了更深刻的體會(huì)，具體使用情況還需要大家實(shí)踐驗(yàn)證。這里是創(chuàng)新互聯(lián)，小編將為大家推送更多相關(guān)知識(shí)點(diǎn)的文章，歡迎關(guān)注！
