Я знаком с стеком Microsoft. Я использую OData для некоторых моих успокоительных сервисов. Недавно я столкнулся с документацией Swagger для API, и я пытаюсь понять, как она относится к OData. Оба они кажутся спецификациями RESTful. Какой из них широко используется?
Что такое Swagger и относится ли это к OData?
Ответ 1
Swagger - это спецификация для документирования API. Создав документ Swagger для вашего API, вы можете передать его экземпляру Swagger UI, который отображает документ в аккуратном читаемом формате и предоставляет инструменты для вызова ваших API. Смотрите сайт swagger.io для получения дополнительной информации.
OData - это спецификация для создания сервисов данных через http, она определяет, как сервис должен быть построен и каким шаблонам он должен следовать. Например, использование директивы $ top для предоставления первых n результатов набора данных. OData в настоящее время находится в версии 4, но документация v2 имеет очень хороший обзор.
Swashbuckle - это пакет nuget для стека Microsoft, который автоматически создает документы для вашего API на основе проверки кода и дополнительных метаданных, предоставленных вами для формирования выходного документа.
Если вы хотите, чтобы Swashbuckle автоматически генерировал документы swagger для создаваемого вами OData API, вы можете использовать Swashbuckle.OData, чтобы предоставить вам это.
OpenAPI - это спецификация для описания API. Swagger - это реализация стандарта OpenAPI. Вы можете найти более подробную информацию здесь.
Надеюсь, это поможет прояснить ситуацию.