Qu'est-ce que Swagger et se rapporte-t-il à OData?
je connais la pile Microsoft. J'utilise OData pour certains de mes services reposants. Récemment, je suis tombé sur Swagger pour la documentation API et je suis en train d'essayer de comprendre comment il se rapporte à OData. Les deux semblent être des spécifications reposantes. Qui est largement utilisé?
1 réponses
Swagger est une spécification pour l' documentation des Api. En créant un document swagger pour votre API, vous pouvez le passer à une instance de Swagger UI, qui rend le document dans un format net et lisible et fournit des outils pour invoquer vos API. Voir le swagger.io site web pour plus d'information.
OData est une spécification pour créer services de données sur http, il définit comment un service doit être construit et quels modèles il devrait suivre. Par exemple, l'utilisation de la directive $top pour fournir les premiers n résultats d'un ensemble de données. OData est actuellement en version 4, mais la documentation v2 a un très bonne vue d'ensemble.
Swashbuckle est un package nuget pour la pile de Microsoft que produit automatiquement des documents swagger pour votre API, basé sur l'inspection du code et des métadonnées supplémentaires que vous fournissez à la forme le document de sortie.
si vous voulez que Swashbuckle génère automatiquement des documents swagger pour une API OData que vous construisez, alors vous pouvez utiliser Swashbuckle.OData pour vous fournir ceci.
j'espère que cela vous aide à dissiper toute confusion.