Как документировать конечные точки OData (swagger, swashbuckle, other)?

Каков наилучший способ документирования конечных точек OData? Есть ли способ использовать Swashbuckle для этого?

Ответ 1

Да, попробуйте Swashbuckle.OData. Он добавляет поддержку Swashbuckle для ODataControllers.

Смотрите здесь: http://swashbuckleodata.azurewebsites.net/swagger

Ответ 2

Да, мы пытаемся его поддерживать, как yaml → Swagger, yaml → csdl..

Но для реализации потребуется время, вы можете увидеть прототип и проследить там https://github.com/OData/model-first

Ответ 3

У меня на самом деле что-то работает, используя функцию IDocumentFilter в Swashbuckle. Я ответил на аналогичный вопрос о репо GitHub для Swashbuckle. Проверьте мой ответ здесь (это либо внизу, либо внизу):

https://github.com/domaindrivendev/Swashbuckle/issues/149

Я опубликовал пример рабочей реализации IDocumentFilter, которую вы могли бы использовать, чтобы получить конечную точку OData, установленную в Swagger ui.

Ответ 4

Самый простой способ сделать это - преобразовать определение OData в спецификацию Open API, используя https://github.com/oasis-tcs/odata-openapi После того, как swagger сможет импортировать этот вид документа.