揚鞭在我的春天啓動的應用程序

Question

什麼是paramType在註釋

@ApiImplicitParams({ 
@ApiImplicitParam(name = RestRequestHeader.XAUTHTOKEN, value = RestRequestHeader.VALUE, required = RestRequestHeader.REQUIRED, dataType = "string", paramType = "header") }) 

有哪些不同的值paramType可以採取，什麼是它的功能？我試圖在谷歌搜索，但找不到任何令人滿意的解決方案。

Answer 1

您是否嘗試過使用文檔？

http://docs.swagger.io/swagger-core/apidocs/com/wordnik/swagger/annotations/ApiImplicitParam.html#paramType()

Answer 2

您可以檢查出 OpenAPI specification。

可能的值是"path", "query", "body", "header", "form"

注意，值必須是小寫。

• path paramtype表明implicitparam的類型進入requestUri

• query意味着它是一個類型URL查詢的PARAMS

• body表示應該從請求體中讀取（有效載荷）

• header表示來自請求標題中的參數

• form表示字段對應於表單參數。

UPDATE

基本上你說的是正確的，你可以在GET方法的情況下使用form或query也。但根據OpenAPI規範，如果您的參數類型爲文件，則消費字段必須爲multipart/form-data，參數類型必須爲形式。 form應該也可以用於在內容類型爲application/x-www-form-urlencoded

對於路徑，如果您RequestParam映射看起來像@RequestMapping("/test/{id}")的東西在這裏，你可以使用path爲您paramType定義id PARAM就可以使用。在這種情況下，您的網址將包含動態值 可以說

例如，一個url https://stackoverflow.com/posts/43342169/edit包含（43342169）這是郵政編號作爲param在url本身，這些類型的參數是路徑參數。