Ich bin vertraut mit dem Microsoft-Stack. Ich verwende OData für einige meiner erholsamen Dienste. Kürzlich stieß ich auf Swagger für API-Dokumentation und ich versuche zu verstehen, wie es sich auf OData bezieht. Beide scheinen RESTful Spezifikationen zu sein. Welcher ist weit verbreitet?Was ist Swagger und bezieht es sich auf OData?
Swagger ist eine Spezifikation für Dokumentation APIs. Wenn Sie ein Swagger-Dokument für Ihre API erstellen, können Sie es an eine Instanz von Swagger UI übergeben, die das Dokument in einem übersichtlichen, lesbaren Format darstellt und Tools zum Aufrufen Ihrer APIs bereitstellt. Weitere Informationen finden Sie auf der Website swagger.io.
OData ist eine Spezifikation Datendienste über http für die Erstellung von definiert es, wie ein Dienst aufgebaut und welche Muster werden sollte sollte folgen. Zum Beispiel die Verwendung der $ top-Direktive, um die ersten n Ergebnisse eines Datensatzes bereitzustellen. OData ist derzeit auf Version 4, aber die v2-Dokumentation hat eine very good overview.
Swashbuckle is a nuget package für den Microsoft-Stack, der Prahlerei Dokumente für Ihre API die Ausgabe in Form Dokument automatisch, basierend auf Inspektion des Codes und zusätzliche Metadaten Sie bieten produziert.
Wenn Sie möchten, dass Swashbuckle automatisch Swagger-Dokumente für eine OData-API generiert, die Sie erstellen, können Sie Swashbuckle.OData verwenden, um dies für Sie bereitzustellen.
Ich hoffe, dies hilft, Verwirrung zu klären.