Swagger：如何組合來自不同API的共享信息

我將swagger 1.5.0支持添加到實現20多個不同REST API的現有Java應用程序中，並將Jersey 1.17.1與包掃描一起使用。有沒有人有任何最佳實踐建議？例如：Swagger：如何組合來自不同API的共享信息

應該揚鞭定義被添加到每個Java類或者它們可以是加入到一個獨立的文件（一個或多個），以避免觸及每一類？
每個API都需要使用@ApiImplicitParam爲第一個類定義的相同頭文件集。而不是重複每個類的每個操作的信息，是有辦法將它應用於所有的API？

2016-10-04 user3722575

有許多方法可以將swagger 1.5.x庫（注意：1.5.10最新）與JAX-RS應用程序集成在一起。我建議你按照像swagger-petstore這樣的方案，並按頂層路徑段來分割文件，這應該提供一個合理的組織。

對於重複標題，可以讓每個資源類擴展一個具有註釋類級別變量的基類。這將適用於擴展它的類中的每個操作。

2016-10-05 01:23:20 fehguy

謝謝。我瀏覽了寵物商店的例子。它已經被設計和實施爲一個開始使用的招搖的應用程序;我將不得不對我的應用進行大量修改，以模仿該應用已完成的操作。如果有與我的應用程序有關的示例的一部分，我將不勝感激地指出它。第二個響應非常令人興奮，因爲我所有的API類都已經擴展了一個基類。我嘗試了一些不同的東西，但無濟於事。您可以詳細說明如何實現它（例如，在基類中，API類中使用哪些註釋...）？ – user3722575

我通過在基類和API類中的特定參數中定義通用參數來實現它。謝謝。 – user3722575

Swagger：如何組合來自不同API的共享信息

回答

相關問題