Qu'est-ce que Swagger et est-ce lié à OData?
Je connais la pile Microsoft. J'utilise OData pour certains de mes services reposants. Récemment, j'ai rencontré Swagger pour la documentation de l'API et j'essaie de comprendre comment cela se rapporte à OData. Les deux semblent être des spécifications RESTful. Lequel est largement utilisé?
Swagger est une spécification pour la documentation des API . En créant un document swagger pour votre API, vous pouvez le transmettre à une instance de Swagger UI, qui rend le document dans un format net et lisible et fournit des outils pour appeler vos API. Voir le site Web swagger.io pour plus d'informations.
OData est une spécification pour créer des services de données sur http , il définit comment un service doit être construit et quels modèles il doit suivre. Par exemple, l'utilisation de la directive $ top pour fournir les n premiers résultats d'un ensemble de données. OData est actuellement à la version 4, mais la documentation v2 a un très bon aperç .
Swashbuckle est un package nuget pour la pile Microsoft qui produit des documents swagger pour vos API automatiquement , basé sur l'inspection du code et des métadonnées supplémentaires que vous fournissez pour façonner le document de sortie.
Si vous souhaitez que Swashbuckle génère automatiquement des documents swagger pour une API OData que vous créez, vous pouvez utiliser Swashbuckle.OData pour fournissez ceci pour vous.
OpenAPI est une spécification pour décrire les API. Swagger est une implémentation de la norme OpenAPI . Vous pouvez trouver plus de détails ici .
J'espère que cela aide à dissiper toute confusion.