swagger或api first

Question

我已經閱讀了swagger的定義和格式，並且明白swagger定義用於描述這些API。

寫出swagger定義然後寫入API會更好嗎？或者首先編寫API，然後是大招？我沒有這方面的經驗，我想爲應用程序編寫一個REST API和一個swagger文件。

Answer 1

我不認爲訂單真的很重要。這兩種方法在Swagger Getting Started Guide中都具有合法性。關鍵是應該從另一個生成一個，所以你不必手動維護兩者。

在評論中，cricket_007已經提到存在工具來根據swagger定義生成web服務框架。使用這些工具，首先編寫swagger定義是有意義的。這是入門指南中的自頂向下方法。

從上面鏈接的Swagger入門指南可以看出，如果您使用的是像JAX-RS這樣的特定框架，也可以從Java代碼中生成Swagger文檔。這是自下而上的方法。

歸結爲個人喜好。如果您是那種寧願將您的代碼庫「耦合」到Swagger並確保您的應用程序不依賴Swagger工作的人，那麼自下而上的方法是最好的。然而，如果你想完全接受Swagger工具鏈，並真正「買進」它，那麼自頂向下的方法可能是最好的。

此外，如果這是爲了教育目的，然後想想你想了解什麼。如果您想了解從頭開始編寫JSON REST API（或者使用類似JAX-RS的東西），那麼自底向上的方法將會教您更多。但是，如果您的目標是儘可能多地學習Swagger，那麼自頂向下的方法會更好。