operationid - ¿Qué es Swagger y se relaciona con OData?

swagger json example

Question

Estoy familiarizado con la pila de Microsoft. Estoy usando OData para algunos de mis servicios tranquilos. Recientemente encontré Swagger para la documentación de la API y estoy tratando de entender cómo se relaciona con OData. Ambos parecen ser especificaciones REST. ¿Cuál es ampliamente utilizado?

Answer 1

Swagger es una especificación para documentar APIs . Al crear un documento de Swagger para su API, puede pasarlo a una instancia de la interfaz de usuario de Swagger, que procesa el documento en un formato ordenado y legible y proporciona herramientas para invocar sus API. Consulte el swagger.io web swagger.io para más información.

OData es una especificación para crear servicios de datos a través de http , define cómo se debe construir un servicio y qué patrones debe seguir. Por ejemplo, el uso de la directiva $ top para proporcionar los primeros n resultados de un conjunto de datos. OData se encuentra actualmente en la versión 4, pero la documentación de v2 tiene una visión general muy buena .

Swashbuckle es un paquete nuget para la pila de Microsoft que produce documentos de forma automática para sus API de forma automática , según la inspección del código y los metadatos adicionales que proporciona para dar forma al documento de salida.

Si desea que Swashbuckle genere automáticamente documentos swagger para una API de OData que está construyendo, entonces puede usar Swashbuckle.OData para proporcionar esto para usted.

En el último par de años ha surgido cierta confusión en torno a OpenAPI en relación con Swagger. OpenAPI ha evolucionado como una especificación para describir las API, mientras que Swagger es una implementación de ese estándar. Puede más detalles here .

Espero que esto ayude a aclarar cualquier confusión.