aspnetcore openapi source generator

ASP.NET -Web -API -Quellgenerator

Richten Sie schnell eine CRUD-Mock-API mit einem Roslyn-basierten Quellgenerator ein, das zum Lesen von OpenAPI-Spezifikationen entwickelt wurde. Erstellen und führen Sie das Projekt mit einer angegebenen YAML -Datei aus und Sie haben eine voll funktionsfähige Mock -API in Sekunden.

Schneller Start

Befolgen Sie diese Schritte, um Ihren Mock -API -Server zum Einsatz zu bringen:

Schritt 1: Klonen Sie das Repository

Klonen Sie dieses Repository in Ihre lokale Maschine:

 cd aspnetcore-openapi-source-generator/src/OpenApi.WebApi

Schritt 2: Führen Sie das Projekt aus

Führen Sie das Projekt aus, indem Sie den Pfad in Ihre OpenAPI -Spezifikation YAML -Datei angeben:

dotnet run -p:OpenApiSpecPath= " path_to_openapi_spec.yaml "

Ersetzen Sie path_to_openapi_spec.yaml durch den Pfad zu Ihrer OpenAPI YAML -Datei. Dieser Befehl erstellt und führt das Projekt aus und generiert die erforderlichen API -Endpunkte, wie in Ihrer YAML -Datei definiert.

Schritt 3: Durchsuchen Sie die API

Nach dem Start der Anwendung wird die URL angezeigt, in der der Server gehostet wird. Append /swagger/index.html zu dieser URL in Ihrem Browser, um Ihre neu erstellte Schein -API über die Swagger -Benutzeroberfläche anzuzeigen und mit ihnen zu interagieren.

http://localhost:5287/swagger/index.html

beitragen

Beiträge sind willkommen! Fühlen Sie sich frei, dieses Repository zu geben und Pull -Anfragen zu senden oder Probleme zu öffnen, um Verbesserungen vorzuschlagen oder Fehler zu melden.

Lizenz

Dieses Projekt ist unter der MIT -Lizenz lizenziert.

Unterstützung

Wenn Sie Hilfe benötigen oder Fragen zur Verwendung dieses Tools haben, öffnen Sie bitte ein Problem im Repository.