2017-04-11 38 views
1

什么是paramType在注释扬鞭在我的春天启动的应用程序

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

有哪些不同的值paramType可以采取,什么是它的功能?我试图在谷歌搜索,但找不到任何令人满意的解决方案。

回答

0

您可以检查出 OpenAPI specification

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

注意,值必须是小写。

  • path paramtype表明implicitparam的类型进入requestUri

  • query意味着它是一个类型URL查询的PARAMS

  • body表示应该从请求体中读取(有效载荷)

  • header表示来自请求标题中的参数

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

UPDATE

基本上你说的是正确的,你可以在GET方法的情况下使用formquery也。但根据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本身,这些类型的参数是路径参数。

+0

请问您可以详细说明'路径'和我的理解是'form'参数将作为查询参数如果操作是GET。那么Waht是'query'和'form'之间的区别? – Virat

+0

谢谢Samarth – Virat

+0

如果这有用,请标记为有用 – Samarth