Was ist Swagger und bezieht es sich auf OData?
Ich bin vertraut mit den Microsoft-stack. Ich bin mit OData für einige meiner restful services. Vor kurzem stieß ich auf Swagger für die API-Dokumentation, und ich versuche zu verstehen, wie es bezieht sich auf OData. Beide von Ihnen zu sein scheinen RESTful-Spezifikationen. Die eine ist weit verbreitet?
Schreibe einen Kommentar
Du musst angemeldet sein, um einen Kommentar abzugeben.
Swagger ist eine Spezifikation für dokumentieren APIs. Durch die Schaffung eines Fors-Dokument für die API, können Sie übergeben es an eine Instanz von Swagger UI, das macht das Dokument in einem sauberen, lesbaren format und bietet Werkzeuge aufrufen, Ihre APIs. Finden Sie die stolzieren.io website für weitere Informationen.
OData ist eine Spezifikation für die Erstellung von Daten-services über http, es legt fest, wie ein Dienst aufgebaut sein sollte und welche Muster Sie Folgen sollten. Zum Beispiel, die Verwendung der $ - top-Richtlinie liefern die ersten n Ergebnisse Daten aus einem Datensatz. OData ist aktuell in version 4, aber die v2-Dokumentation hat eine sehr gute übersicht.
Swashbuckle ist ein nuget-Paket für den Microsoft-stack, der produziert swagger Dokumente für Ihre API automatisch, basierend auf Einsicht in den code und zusätzlichen Metadaten, die Sie prägen das Ausgabe-Dokument.
Wenn Sie möchten, Swashbuckle automatisch generieren zu stolzieren Dokumente für einen OData-API, die Sie bauen, dann können Sie Swashbuckle.OData zu bieten.
Open API ist eine Spezifikation für die Beschreibung der API. Swagger ist eine Implementierung der Open API standard. Sie finden weitere details hier.
Ich hoffe, das hilft klären Verwechslungen.