1.

@ApiOperation("swaggerTest")

用來描述當前的api的簡略資訊

我來解釋下為什麼會出現這麼多比如DELETE,GET,HEAED啥的請求，因為swagger預設將所有請求全部顯示出來，為了解決這種情況，我們其實可以將這個api單獨定義為post或者get：

這樣，我們在swagger的網頁裡面就能看到這樣的效果

2.

@ApiImplicitParam(name = "id", value = "ID", required = true, dataType = "Long",paramType = "query")

用來在swagger的網頁裡面顯示api的輸入，主要目的在於api的測試，下面的@ApiParam用法也差不多 

name:引數名

value:描述

required:是否必須填，也就是說，= true的時候，你必須填這個資料才能向你的伺服器提交

dataType：資料型別

paramType：引數型別
這個有五個選項
path, query, body, header, form

除了query可以正常的傳遞String，float，之類的，其他的我就不是很清楚

 3.  多個引數

@ApiImplicitParams({
@ApiImplicitParam(name = "userName",value = "使用者名稱",required = true,dataType = "String",paramType="query"),
@ApiImplicitParam(name = "password",value = "密碼",required = true,dataType = "String",paramType="query")
})
 

可以通過這種方法發射多個引數，然後通過@RequestParam dataType name獲得引數

4. 

@ApiParam(required=true,value="封面圖片")

swagger裡面用來宣告該引數為輸入引數。

舉個例子

	@PostMapping("/swaggerTest")
	public void swaggerTest(
			@ApiParam(required = true,value = "@ApiParam測試" )
			@RequestParam float userName
	)
	{
		System.out.print(userName);
	
	}
 

原創部落格，轉載請標明引用