thông số Swagger (phun) đường dẫn bên trong url nguồn

Question

Nói rằng tôi có một url nguồn parametrized như

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

Làm thế nào tôi nên annotatate/chia tuyến đường phun của tôi (sử dụng các plugin phun vênh vang) để tạo ra một tài liệu mà sẽ nhận ra {CUSTOMER-ID} như một tham số đường dẫn thích hợp?

Vấn đề của tôi là chú thích @Api cấp cao nhất có đường dẫn nhưng không có tham số, trong khi @ApiOperation có thể được chú thích với thông số đường dẫn nhưng chúng được nối vào cuối. Nói cách khác, nếu tôi viết:

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

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

Tôi chỉ nhận được ID giao diện người dùng làm thông số có thể kiểm tra, trong khi CUSTOMER-ID, khi được báo cáo là trong {}, chỉ là một chuỗi.

Tôi muốn có thứ gì đó có cả hai tham số đường dẫn.

Bất kỳ ý tưởng nào?

Answer 1

khách hàng là điểm nhập @Api của bạn, không phải là thông số đường dẫn. Thông số đường dẫn chỉ được sử dụng để @ApiOperation như sau (với nhiều mẫu hơn):

@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")