swagger codegen 如何创建 .json

swagger codegen how to create .json

我最近加入了一个正在创建 RESTful API 的团队。我是这个领域的初学者。我的任务是创建项目的 SDK。我必须为此使用 swagger-codegen。我正在按照 swagger-codegen

中的说明进行操作

他们正在使用 http://petstore.swagger.io/v2/swagger.json 文件构建 sdk。但是在我的项目中没有可用的 .json 文件。当我使用 mvn clean package 构建项目时,我得到的只是 .war files.

所以我想知道的是,我是否需要创建 .json 文件来构建 SDK,如果需要,我该如何构建它?或者我可以用任何其他方式做到这一点吗?

抱歉我对这个问题缺乏了解。

首先,您需要在 OpenAPI/Swagger spec 2.0(yaml/json 文件)中记录您的 REST API。

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

获得规范(yaml/json 文件)后,您可以使用 Swagger Codegen(免费、开源)生成 API 客户端、服务器存根和 API 文档。

仅供参考。可以在 https://github.com/OAI/OpenAPI-Specification/blob/3.0.0-rc0/versions/3.0.md

中找到 OpenAPI 3.0 (RC)