電腦:聯想筆記本、系統Windows10
Spring Tool Suite 4引入swagger依靠,如下圖所示。
在啟動類的同級目次下建立Swagger2類,作為設置裝備擺設類,如下圖所示。
★經由過程@Configuration標識表記標幟此類為設置裝備擺設類,會在SpringBoot項目啟動的時辰加載,@EnableSwagger2用來啟動Swagger。
★Swagger會主動掃描我們設置裝備擺設的cn.com.wenyi.controller包下的接口主動生當作接口文檔。
在Controller類上利用@Api注解,如下圖所示。
在方式上利用@ApiOperation注解來給API增添方式申明,如下圖所示。
在方式上利用@ApiImplicitParams或者@ApiImplicitParam注解,用來給方式入參增添申明,如下圖所示。
在實體類上利用@ApiModel注解,描述一個Model的信息,如下圖所示。
在實體類的屬于變量上利用@ApiModelProperty,描述一個model的屬性,如下圖所示。
啟動Spring Boot程序,拜候:http://localhost:8080/swagger-ui.html,看看顯示結果,如下圖所示。
總結:
1、引入swagger依靠
2、建立Swagger2類,利用@Configuration與@EnableSwagger2
3、利用@Api
4、利用@ApiOperation
5、利用@ApiImplicitParams或者@ApiImplicitParam
6、利用@ApiModel
7、利用@ApiModelProperty
8、拜候:http://localhost:8080/swagger-ui.html
0 篇文章
如果覺得我的文章對您有用,請隨意打賞。你的支持將鼓勵我繼續創作!