Jak dokumentować punkty końcowe OData (swagger, swashbuckle, other)?

Question

Jaki jest najlepszy sposób dokumentowania punktów końcowych OData? Czy istnieje sposób na wykorzystanie Swashbuckle dla niego?

Answer 1

Tak, staramy się wspierać go jak YAML -> Swagger, YAML -> CSDL ..

Ale to wymaga czasu realizacji można zobaczyć prototyp i śledzić tam https://github.com/OData/model-first

Answer 2

I faktycznie ma coś do pracy za pomocą funkcji IDocumentFilter w Swashbuckle. Odpowiedziałem na podobne pytanie w repozytorium GitHub dla Swashbuckle. Sprawdź moją odpowiedź tutaj (to albo na dnie lub w kierunku dołu):

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

ja pisał przykład realizacji IDocumentFilter pracy, które mogą Ci wykorzystać, aby uzyskać OData końcowym skonfigurować w interfejsie Swagger .

Answer 3

Tak, spróbuj Swashbuckle.OData. Dodaje obsługę Swashbuckle dla ODataControllers.

Zobacz w działaniu tutaj: http://swashbuckleodata.azurewebsites.net/swagger