前言：

@Api，@ApiOperation，@ApiImplicitParam，@ApiModelProperty，@ApiIgnore

正文：

一，Controller層

@ApiIgnore

@CrossOrigin(origins= "*")

@RestController

@Api(tags= {"文章接口"})public classArticleController {

@ApiIgnore

@ApiOperation(value= "文章詳情")

@ApiImplicitParams({

@ApiImplicitParam(name= "id", value = "文章編號", required = true, dataType = "String", paramType = "query", example="12345"),

})

@RequestMapping(value= "article", method =RequestMethod.GET)public ResultgetArticleInfo(@ApiIgnore String id) {return this.theService.getArticleInfo(id);

}

}

@Api：作用在類上，用來標(biāo)注該類具體實現(xiàn)內(nèi)容。

參數(shù)：

1，tags：該類的名稱

2，description：描述該類的作用

@ApiOperation：表示一個http請求的操作

參數(shù)：

1，value ： 接口名稱

@ApiImplicitParam：接口的單個請求參數(shù) ，根據(jù)需要選擇

參數(shù)：

1，name ：參數(shù)名

2，value ： 描述參數(shù)名

3，required ： 該參數(shù)是否必填

4，dataType ：參數(shù)的數(shù)據(jù)類型

4，example：舉例

6， paramType ：查詢參數(shù)類型。這里有幾種形式：

類型

作用

path

以地址的形式提交數(shù)據(jù)

query

直接跟參數(shù)完成自動映射賦值

body

以流的形式提交 僅支持POST

header

參數(shù)在request headers 里邊提交

form

以form表單的形式提交 僅支持POST

@ApiIgnore

表示忽略該方法、類、參數(shù)，不顯示在swagger-ui.html上

二，如果傳入的參數(shù)是用實體類接收的

public classAddVo {

@ApiModelProperty(name="province", value="所在省", required=true)privateString province;

@ApiModelProperty(name="city", value="所在市", required=true)privateString city;

}

@ApiModelProperty：同@ApiImplicitParam一致

參考博客：

@ApiIgnore 注解的用法

總結(jié)

以上是生活随笔為你收集整理的swagger3 设置值可以为空_【Swagger2】【3】API注解详解，以及注解常用参数配置的全部內(nèi)容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網(wǎng)站內(nèi)容還不錯，歡迎將生活随笔推薦給好友。