SpringBoot集成Swagger2構(gòu)建在線API文檔的代碼詳解
第一部分:代碼集成
pom.xml
<!--swagger2配置--> <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger-ui</artifactId> <version>2.4.0</version> </dependency> <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId> <version>2.4.0</version> </dependency> <dependency> <groupId>com.github.xiaoymin</groupId> <artifactId>swagger-bootstrap-ui</artifactId> <version>1.6</version> </dependency>
swagger2配置類
package com.liud.demo.config; import io.swagger.annotations.ApiOperation; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; import springfox.documentation.builders.ApiInfoBuilder; import springfox.documentation.builders.PathSelectors; import springfox.documentation.builders.RequestHandlerSelectors; import springfox.documentation.service.ApiInfo; import springfox.documentation.service.Contact; import springfox.documentation.spi.DocumentationType; import springfox.documentation.spring.web.plugins.Docket; import springfox.documentation.swagger2.annotations.EnableSwagger2; /** * TODO * swagger2配置類 * @author liud * @version 1.0 */ @Configuration @EnableSwagger2 public class Swagger2 { //配置swagger2核心配置 @Bean public Docket createRestApi(){ return new Docket(DocumentationType.SWAGGER_2) //指定api類型位swagger2 .apiInfo(apiInfo()) //用于定義api文檔匯總信息 .select() //.apis(RequestHandlerSelectors.basePackage("com.liud.demo.controller")) //指定生成文檔的controller //.apis(RequestHandlerSelectors.any()) //為任何接口生成API文檔 //.apis(RequestHandlerSelectors.withClassAnnotation(Api.class)) //為有@Api注解的Controller生成API文檔 .apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class)) //為有@ApiOperation注解的方法生成API文檔 .paths(PathSelectors.any()) .build(); } //api基本信息 private ApiInfo apiInfo(){ return new ApiInfoBuilder() .title("SpringBootDemo的項目接口API") //文檔標(biāo)題 .contact(new Contact("liud", //作者 "", "")) //聯(lián)系人 .description("SpringBootDemo的項目接口API")//詳細信息 .version("1.0.0")//文檔版本號 .termsOfServiceUrl("")//網(wǎng)站地址 .build(); } }
Controller
package com.liud.demo.controller; import com.liud.demo.service.HelloService; import io.swagger.annotations.Api; import io.swagger.annotations.ApiOperation; import io.swagger.annotations.ApiParam; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.beans.factory.annotation.Value; import org.springframework.web.bind.annotation.*; import javax.servlet.http.HttpServletRequest; /** * TODO * * @author liud * @version 1.0 */ @RestController @Api(tags = {"hello操作接口"}) public class HelloController { @ApiOperation(value = "根據(jù)用戶名獲取用戶信息接口") @RequestMapping(value = "/getuserinfo",method = RequestMethod.POST) public String getUserInfo(HttpServletRequest request, @ApiParam(name="username",value = "用戶名",required = true) String username){ return "輸入的姓名:"+username+",這個用戶的信息已經(jīng)存在!"; } }
第二部分 使用 ①原路徑模式
在瀏覽器上輸入url:
http://{ip}:{port}/swagger-ui.html#/
我的地址:http://127.0.0.1:8081/swagger-ui.html
②文檔模式
在瀏覽器上輸入url:
http://{ip}:{port}/doc.html
我的地址:http://127.0.0.1:8081/doc.html
第三部分 swagger2常用注解
常用注解:
@Api()用于類;
表示標(biāo)識這個類是swagger的資源
tags–表示說明
value–也是說明,可以使用tags替代
但是tags如果有多個值,會生成多個list
效果:
@ApiOperation()用于方法;
表示一個http請求的操作
value用于方法描述
notes用于提示內(nèi)容
tags可以重新分組(視情況而用)
@ApiParam()用于方法,參數(shù),字段說明;
表示對參數(shù)的添加元數(shù)據(jù)(說明或是否必填等)
name–參數(shù)名
value–參數(shù)說明
required–是否必填
@ApiParam(name="username",value = "用戶名",required = true) String username
效果:
- @ApiModel()用于類
- 表示對類進行說明,用于參數(shù)用實體類接收
- @ApiModelProperty()用于方法,字段
- 表示對model屬性的說明或者數(shù)據(jù)操作更改
- @ApiIgnore()用于類,方法,方法參數(shù)
- 表示這個方法或者類被忽略
- @ApiImplicitParam() 用于方法
- 表示單獨的請求參數(shù)
- @ApiImplicitParams() 用于方法,包含多個@ApiImplicitParam
到此這篇關(guān)于SpringBoot集成Swagger2構(gòu)建在線API文檔的文章就介紹到這了,更多相關(guān)SpringBoot集成Swagger2內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家!
- Spring MVC利用Swagger2如何構(gòu)建動態(tài)RESTful API詳解
- 詳解spring cloud整合Swagger2構(gòu)建RESTful服務(wù)的APIs
- SpringBoot2.1 RESTful API項目腳手架(種子)項目
- SpringBoot結(jié)合Swagger2自動生成api文檔的方法
- swagger2隱藏在API文檔顯示某些參數(shù)的操作
- SpringBoot2.7?WebSecurityConfigurerAdapter類過期配置
- springboot2+es7使用RestHighLevelClient的示例代碼
- 淺談Springboot2.0防止XSS攻擊的幾種方式
- Spring Boot2配置Swagger2生成API接口文檔詳情
相關(guān)文章
SpringBoot啟動報錯Failed to determine a suitable driver class
這篇文章主要介紹了SpringBoot啟動報錯Failed to determine a suitable driver class,小編覺得挺不錯的,現(xiàn)在分享給大家,也給大家做個參考。一起跟隨小編過來看看吧2019-05-05Java中ThreadLocal避免內(nèi)存泄漏的方法詳解
ThreadLocal是Java中的一個線程本地存儲機制,它允許每個線程擁有一個獨立的本地存儲空間,用于存儲該線程的變量,本文主要介紹了ThreadLocal如何避免內(nèi)存泄漏,需要的朋友可以參考下2023-05-05詳解SpringBoot項目的創(chuàng)建與單元測試
這篇文章主要介紹了詳解SpringBoot項目的創(chuàng)建與單元測試,幫助大家更好的理解和學(xué)習(xí)使用SpringBoot,感興趣的朋友可以了解下2021-03-03Java7之forkjoin簡介_動力節(jié)點Java學(xué)院整理
Java7引入了Fork Join的概念,來更好的支持并行運算。接下來通過本文給大家分享Java7之forkjoin簡介,感興趣的朋友一起看看吧2017-06-06Java并發(fā)編程(CyclicBarrier)實例詳解
這篇文章主要介紹了Java并發(fā)編程(CyclicBarrier)實例詳解的相關(guān)資料,JAVA編寫并發(fā)程序的時候,我們需要仔細去思考一下并發(fā)流程的控制,如何讓各個線程之間協(xié)作完成某項工作。2017-07-07