java - 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 规范 2.0（yaml/json 文件）中记录您的 REST API。

您还可以使用C# Swashbuckle等插件从 RESTful 后端自动生成 OpenAPI/Swagger 规范。

获取规范（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中找到