How to document OData endpoints (swagger, swashbuckle, other)?

odata swagger swagger-ui swagger-2.0 swashbuckle
free4ride picture free4ride · Aug 5, 2015 · Viewed 12.2k times · Source

What is the best way of documenting OData endpoints? Is there a way to use Swashbuckle for it?

Answer

Richard Beauchamp picture Richard Beauchamp · Nov 18, 2015

Yes, try Swashbuckle.OData. It adds Swashbuckle support for ODataControllers.

See it in action here: http://swashbuckleodata.azurewebsites.net/swagger

Related questions

What is Swagger and does it relate to OData?

I am familiar with the Microsoft stack. I am using OData for some of my restful services. Recently I came across Swagger for API documentation and I am trying to understand how it relates to OData. Both of them seem …

Read More
Could not load file or assembly 'System.Web.Http 4.0.0 after update from 2012 to 2013

I did the upgrade according to. http://www.asp.net/mvc/tutorials/mvc-5/how-to-upgrade-an-aspnet-mvc-4-and-web-api-project-to-aspnet-mvc-5-and-web-api-2 I get the error. Does any one else got this error? Server Error in '/' Application. Could not load file or assembly 'System.…

Read More
415 Unsupported Media Type - POST json to OData service in lightswitch 2012

I am getting 'error 415: Unsupported Media Type' when posting to an OData service when using JSON. Solution at the bottom of this rather long post. I can GET using JSON but as soon as I try and POST I get …

Read More