Swagger在我的春季启动应用程序中

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查询参数

• body表示应该从请求正文（有效负载）读取

• header表示请求标头中的参数

• form表示字段对应于表单参数。

<强>更新

基本上你说的是正确的，你也可以在GET方法的情况下使用form或query。但根据OpenAPI规范，如果参数类型为文件，则消费字段必须为 multipart / form-data ，并且paramType必须为形式 。当内容类型为form

时，也应使用application/x-www-form-urlencoded

对于路径，如果您的RequestParam映射看起来像@RequestMapping("/test/{id}")，您可以使用path作为paramType来定义id参数。在这种情况下，您的网址将包含动态值 让我们说

例如一个网址 https://stackoverflow.com/posts/43342169/edit包含（43342169），其后缀为url本身的param，这些类型的params是路径参数。