swagger2的接口文檔
阿新 • • 發佈:2019-03-27
info 。。 bsp iop com bubuko img 沒有 uri
以前見過一個swagger2的接口文檔,特別好用,好看,對接口中入參描述的很詳細;適合用於項目的開發
後來自己做項目的時候,沒有找到這個swagger版本
<dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId> <version>2.9.2</version> </dependency> <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger-ui</artifactId> <version>2.9.2</version> </dependency>
這個版本的風格如下:
備註:
@Api: 描述類/接口的主要用途
@ApiOperation: 描述方法用途
@ApiImplicitParam: 描述方法的參數
@ApiImplicitParams: 描述方法的參數(Multi-Params)
@ApiParam:請求屬性
@ApiIgnore: 忽略某類/方法/參數的文檔
@ApiResponses:響應集配置
@ResponseHeader: 響應頭設置
@ApiModelProperty:添加和操作模型屬性的數據
<dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId> <version>2.2.2</version> </dependency> <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger-ui</artifactId> <version>2.2.2</version> </dependency>
換了個版本,三個2的版本,
高版本UI展示變了,高版本能顯示實體類中的對象屬性
不是之前我看到的,還是要繼續尋找更好的API接口文檔展示方式。。。。
swagger2的接口文檔