如何使用Swagger參數化POST的URL？

Question

我想定義使用Swagger以下路徑：

/api/libraries/1234/books 

而且POST一書的藏書圖書館，id爲1234。

在這個例子中，我看到這裏：https://github.com/swagger-api/swagger-spec/blob/master/examples/v2.0/json/petstore-with-external-docs.json

它顯示一樣，你可以指定例如：libraries/{id}/books，但你必須把它定義爲一個獨立的路徑對象。

例如，與libraries比較，對於GET的目的;它將檢索你的庫列表。

有一種方法以定義sub path對象（例如： libraries下限定id的sub path），並在其下一個的bookssub path;也許另一個sub path的employees？

Answer 1

簡短的回答是否定的。

根據swagger spec 2.0不支持嵌套路徑;您必須獨立定義路徑（https://github.com/swagger-api/swagger-spec/blob/master/versions/2.0.md#pathItemObject）。

然後，您可以將資源列表分組使用標籤。

原子路徑的原因在於Swaggers強烈遵守REST規範。在REST資源中鏈接到獨立的原子操作（與SOAP/RPC不同）。

Answer 2

不知道如果我正確地理解你的問題，但如果你要定義/api/libraries/1234/books/5678/employees/9999路徑變量爲例，路徑應該是這樣的：

/api/libraries/{library_id}/books/{book_id}/employees/{employe_id} 

其中{library_id}，{book_id}和{employee_id}是路徑變​​量。