параметры Кураж (спрей) путь внутри URL ресурса

Question

Скажем, у меня есть параметризованным URL ресурса, как

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

Как я должен annotatate/разделить мои аэрозольные маршруты (с помощью спрей-чванство плагин) для создания документации, которая будет распознать {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")) 

я получаю в пользовательском интерфейсе только ЭЛЕМЕНТ-ID в качестве тестируемой параметра, в то время как КЛИЕНТ-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")