您好,登錄后才能下訂單哦!
今天就跟大家聊聊有關(guān)IDEA 中的SpringBoot 項(xiàng)目使用Swagger2的方法,可能很多人都不太了解,為了讓大家更加了解,小編給大家總結(jié)了以下內(nèi)容,希望大家根據(jù)這篇文章可以有所收獲。
1、SpringBoot-web項(xiàng)目并添加pom.xml依賴
2、編寫(xiě)HelloController,測(cè)試成功運(yùn)行
3、創(chuàng)建一個(gè)SwaggerConfig類,配置swagger-ui
流程確實(shí)是很簡(jiǎn)單的,但是能真正的在項(xiàng)目中活用swagger卻不是那么簡(jiǎn)單
1、SpringBoot-web項(xiàng)目并添加pom.xml依賴
可以直接在maven repository搜索
多最一句,一般在選擇maven依賴時(shí),我們趨向于選擇最穩(wěn)定版本,可以通過(guò)Usages判斷,盡量不要選擇最新版,及時(shí)并沒(méi)有什么影響。詳細(xì)經(jīng)歷過(guò)版本沖突和版本不兼容的小伙伴應(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、編寫(xiě)HelloController,測(cè)試成功運(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 = "測(cè)試-HelloWorld") //這個(gè)controller下的所有接口的描述 public class HelloController { @ApiOperation("測(cè)試Swagger2") //顯示在接口的信息說(shuō)明 @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 @EnableSwagger2 public class SwaggerConfig { }
然后就可以根據(jù)你的端口訪問(wèn)swagger-ui了,例如我的是8099
http://localhost:8099/swagger-ui.html#/
至此IDEA 繼承Swagger就可以了,但這僅僅只是個(gè)開(kāi)始,swagger還是有很多的實(shí)用技巧。
看完上述內(nèi)容,你們對(duì)IDEA 中的SpringBoot 項(xiàng)目使用Swagger2的方法有進(jìn)一步的了解嗎?如果還想了解更多知識(shí)或者相關(guān)內(nèi)容,請(qǐng)關(guān)注億速云行業(yè)資訊頻道,感謝大家的支持。
免責(zé)聲明:本站發(fā)布的內(nèi)容(圖片、視頻和文字)以原創(chuàng)、轉(zhuǎn)載和分享為主,文章觀點(diǎn)不代表本網(wǎng)站立場(chǎng),如果涉及侵權(quán)請(qǐng)聯(lián)系站長(zhǎng)郵箱:is@yisu.com進(jìn)行舉報(bào),并提供相關(guān)證據(jù),一經(jīng)查實(shí),將立刻刪除涉嫌侵權(quán)內(nèi)容。