scala - 资源 url 中的 Swagger (spray) 路径参数

Question

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

/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 在报告为 { } 时只是一个字符串。

我想要一些东西，其中两者都是路径参数。

任何的想法？

Answer 1

客户是您的@Api 入口点，而不是路径参数。路径参数必须仅用于@ApiOperation 如下(更多示例):

@Api(value = "/customers")

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

@ApiOperation(value = "/{CUSTOMER-ID}", httpMethod = "GET")
@ApiImplicitParams(Array(
  new ApiImplicitParam(name = "CUSTOMER-ID", required = true, dataType = "string", paramType = "path"))

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