IDEA SpringBoot 項(xiàng)目配置Swagger2的詳細(xì)教程
在項(xiàng)目中也經(jīng)常用到swagger2,于是動(dòng)手記錄一下swagger2配置過程,希望能帶來一點(diǎn)幫助。
在SpringBoot項(xiàng)目當(dāng)中使用Swagger主要分為以下幾步:
1、SpringBoot-web項(xiàng)目并添加pom.xml依賴
2、編寫HelloController,測試成功運(yùn)行
3、創(chuàng)建一個(gè)SwaggerConfig類,配置swagger-ui
流程確實(shí)是很簡單的,但是能真正的在項(xiàng)目中活用swagger卻不是那么簡單
1、SpringBoot-web項(xiàng)目并添加pom.xml依賴
可以直接在maven repository搜索
多最一句,一般在選擇maven依賴時(shí),我們趨向于選擇最穩(wěn)定版本,可以通過Usages判斷,盡量不要選擇最新版,及時(shí)并沒有什么影響。詳細(xì)經(jīng)歷過版本沖突和版本不兼容的小伙伴應(yīng)該深有體會(huì)。
<!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger2 --><dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId> <version>2.9.2</version></dependency><!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger-ui --><dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger-ui</artifactId> <version>2.9.2</version></dependency>
2、編寫HelloController,測試成功運(yùn)行
package cn.swpu.myblog.controller;import io.swagger.annotations.Api;import io.swagger.annotations.ApiOperation;import org.springframework.stereotype.Controller;import org.springframework.web.bind.annotation.RequestMapping;import org.springframework.web.bind.annotation.RequestMethod;@Controller@Api(tags = '測試-HelloWorld') //這個(gè)controller下的所有接口的描述public class HelloController { @ApiOperation('測試Swagger2') //顯示在接口的信息說明 @RequestMapping(value = '/test', method = RequestMethod.GET) //請(qǐng)求路徑和類型 public void testSwagger(){ }}
3、創(chuàng)建一個(gè)SwaggerConfig類,配置swagger-ui
package cn.swpu.myblog.config;import org.springframework.context.annotation.Configuration;import springfox.documentation.swagger2.annotations.EnableSwagger2;@Configuration@EnableSwagger2public class SwaggerConfig {}
然后就可以根據(jù)你的端口訪問swagger-ui了,例如我的是8099
http://localhost:8099/swagger-ui.html#/
至此IDEA 繼承Swagger就可以了,但這僅僅只是個(gè)開始,swagger還是有很多的實(shí)用技巧。
到此這篇關(guān)于IDEA SpringBoot 項(xiàng)目配置Swagger2的詳細(xì)教程的文章就介紹到這了,更多相關(guān)IDEA SpringBoot 項(xiàng)目配置Swagger2內(nèi)容請(qǐng)搜索好吧啦網(wǎng)以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持好吧啦網(wǎng)!
相關(guān)文章:
1. python excel和yaml文件的讀取封裝2. python如何實(shí)現(xiàn)word批量轉(zhuǎn)HTML3. python爬蟲實(shí)戰(zhàn)之制作屬于自己的一個(gè)IP代理模塊4. moment轉(zhuǎn)化時(shí)間戳出現(xiàn)Invalid Date的問題及解決5. Android從按下開機(jī)鍵到啟動(dòng)發(fā)生了什么6. Android中的緩存7. Android通用流行框架大全8. 一個(gè)Android項(xiàng)目搞定所有主流架構(gòu)9. java——Byte類/包裝類的使用說明10. Python中內(nèi)建模塊collections如何使用
