swagger codegen wie zu erstellen .json

Question

Ich bin kürzlich einem Team beigetreten, die RESTful API erstellen. Ich bin ein Anfänger auf diesem Gebiet. Meine Aufgabe ist es, das SDK des Projekts zu erstellen. Ich muss Swagger-Codegen dafür verwenden. Ich bin nach Anleitung in swagger-codegen

Dort werden sie http://petstore.swagger.io/v2/swagger.json Datei werden mit dem sdk zu bauen. Aber in meinem Projekt gibt es keine .json Datei. Wenn ich das Projekt unter Verwendung mvn sauberes Paket baue, bekomme ich nur .war Dateien.

Also was ich wissen möchte ist, muss ich .json Datei erstellen, um ein SDK zu bauen, wenn ja, wie bau ich es? oder kann ich es anders machen?

Entschuldigung für meinen Mangel an Wissen zu diesem Thema.

Answer 1

Sie müssen Ihre REST-API zunächst unter OpenAPI/Swagger spec 2.0 (yaml/json-Datei) dokumentieren.

Sie können auch Plug-Ins wie C# Swashbuckle verwenden, um OpenAPI/Swagger-Spezifikationen automatisch aus Ihrem REST-fähigen Backend zu generieren.

Nachdem Sie die Spezifikation (yaml/json-Datei) erhalten haben, können Sie Swagger Codegen (frei, Open Source) verwenden, um API-Clients, Server-Stubs und API-Dokumentationen zu generieren.

FYI. OpenAPI 3.0 (RC) kann in https://github.com/OAI/OpenAPI-Specification/blob/3.0.0-rc0/versions/3.0.md