Webapi: Help pages for odata controllers
I would like to request that the help pages, like on standard asp.net web api
be provided for odata controllers as well. Currently the tooling does not work
for odata.
http://stackoverflow.com/questions/23087628/asp-net-web-api-help-pages-
showing-no-content-for-odata-controllers
Work Item Details
Original CodePlex Issue: Issue 1892
Status: Proposed
Reason Closed: Unassigned
Assigned to: Unassigned
Reported on: Apr 29, 2014 at 4:15 PM
Reported by: psteele706
Updated on: Wed at 9:33 AM
Updated by: miguelbondoso
LianwMS
All 18 comments
On _2014-07-10 07:28:13 UTC_, kirkpabk commented:
Understanding that System.Web.Http.OData/OData/EntitySetController.cs and System.Web.Http.OData/OData/AsyncEntitySetController.cs explicitly set the [ApiExplorerSettings(IgnoreApi = true)], I would like to see WebAPI-like documentation that enhances the
usability and professional presentation of "published" API or ODATA services with some similar "sample" query links and CRUD capability. This is the usability and "polish" side that supports broad acceptance (upper managers love
this sort of quick win solution).
LianwMS
on 12 Jan 2015
On _2014-07-11 20:21:04 UTC_, psteele706 commented:
Good point. Documentation is always a challenge to get done, especially early-on when service consumers could actually use it! The documentation capability was a rave on Web API, it should be for ODATA too.
LianwMS
on 12 Jan 2015
On _2014-08-12 18:33:49 UTC_, Veikko commented:
This looks like being a duplicate to
Implement ODATA HelpPages Similar to WebAPI. I put my vote here as I came through the SO link and I suspect so do many others in the future.
WebApi like documentation would be hugely nice.
LianwMS
on 12 Jan 2015
On _2014-08-12 18:45:20 UTC_, Veikko commented:
As a further note, maybe the "polished help API" could be more interfactive too. Would it be possible to reuse code from
TripPin OData explorer by
PragmatiQa? See also
TripPin – New OData V4 Sample Service.
LianwMS
on 12 Jan 2015
On _2014-09-19 04:25:05 UTC_, coolnsdc commented:
I would love to see the ApiExplorer handle OData controllers as well!
LianwMS
on 12 Jan 2015
+1 I would love it as well!
Tpeinoit
on 1 Jun 2015
I would love it too!
vladbilyk
on 3 Jun 2015
+1! Would love it too.
AskYous
on 4 Jun 2015
This would be particularly nice for Apis that annotate fields in their metadata document with description annotations or similar autogebwrated doc comments
ghost
on 4 Jun 2015
Help pages are very helpfull, even on odata controller´s...
RichardSilveira
on 10 Jun 2015
+1 really searching for a solution now to autogenerate the docs. I'm going to try all sorts of work arounds now but if some good solution came out of this I'll be very happy.
Ghkuijer
on 11 Jul 2015
+1 any update on this?
cohenomri
on 22 Jul 2015
:+1: Any news on this?
mgernand
on 1 Sep 2015
+1
danroot
on 22 Sep 2016
+1
Gebov
on 11 Oct 2016
+1
iarly
on 27 Mar 2017
Nowadays i think which a better approach is to use swagger docs
RichardSilveira
on 13 Apr 2017
any news?
albertoVieiraNeto
on 24 Nov 2017
Related issues
sheam
·
3Comments
LianwMS
·
5Comments
johnhzhu
·
4Comments
christiannagel
·
4Comments
IgorWolbers
·
3Comments
Most helpful comment
Nowadays i think which a better approach is to use swagger docs