scala – 资源URL内的Swagger(喷射)路径参数

发布时间：2020-12-16 18:28:31 所属栏目：安全来源：网络整理

导读：假设我有一个参数化的资源网址 /customers/{CUSTOMER-ID}/ownedItems/{ITEM-ID} 我应该如何注释/拆分我的喷涂路径(使用spray-swagger插件)生成一个文档,将{CUSTOMER-ID}识别为正确的路径参数？我的问题是顶级@Api注释采用路径但没有参数,而@ApiOperation可

假设我有一个参数化的资源网址

/customers/{CUSTOMER-ID}/ownedItems/{ITEM-ID}

我应该如何注释/拆分我的喷涂路径(使用spray-swagger插件)生成一个文档,将{CUSTOMER-ID}识别为正确的路径参数？

我的问题是顶级@Api注释采用路径但没有参数,而@ApiOperation可以使用路径参数进行注释,但最后会附加这些参数.换句话说,如果我写：

@Api(value = "/customers/{CUSTOMER-ID}")

@ApiOperation(httpMethod = "GET")
@ApiImplicitParams(Array(
new ApiImplicitParam(name = "ITEM-ID",required = true,dataType = "string",paramType = "path"))

我在UI中仅将ITEM-ID作为可测试参数,而CUSTOMER-ID在报告为{}时只是一个字符串.

我想要两个都是路径参数的东西.

任何的想法？

解决方法

客户是您的@Api入口点,而不是路径参数.路径参数必须仅用于@ApiOperation,如下所示(更多样本)：

@Api(value = "/customers")

@ApiOperation(value = "/{CUSTOMER-ID}/ownedItems/{ITEM-ID}",httpMethod = "GET")
@ApiImplicitParams(Array(
  new ApiImplicitParam(name = "CUSTOMER-ID",paramType = "path"),new ApiImplicitParam(name = "ITEM-ID",paramType = "path"))

@ApiOperation(value = "/{CUSTOMER-ID}",paramType = "path"))

@ApiOperation(value = "/",httpMethod = "POST")

（编辑：李大同）

【声明】本站内容均来自网络，其相关言论仅代表作者个人观点，不代表本站立场。若无意侵犯到您的权利，请及时与联系站长删除相关内容!