swagger codegen如何創建.json

Question

我最近加入了一個創建RESTful API的團隊。我是這個領域的初學者。我的任務是創建項目的SDK。我必須使用swagger-codegen。我遵循swagger-codegen的說明

他們在那裏使用http://petstore.swagger.io/v2/swagger.json文件來構建sdk。但在我的項目中沒有可用的.json文件。當我使用mvn clean package使用.war文件構建項目時。

所以我想知道的是，我是否需要創建.json文件來構建SDK，如果是的話，我該如何構建它？或者我可以用其他方式做到嗎？

對於我在這方面缺乏認識感到抱歉。

Answer 1

您將需要在OpenAPI/Swagger spec 2.0（yaml/json文件）中記錄您的REST API以開始。

您也可以使用插件像C# Swashbuckle從您的REST風格的後臺自動生成的OpenAPI /揚鞭規範。

獲得spec（yaml/json文件）後，您可以使用Swagger Codegen（免費，開放源代碼）生成API客戶端，服務器存根和API文檔。

僅供參考。 OpenAPI 3.0（RC）可以在https://github.com/OAI/OpenAPI-Specification/blob/3.0.0-rc0/versions/3.0.md