Aspnetcore: What is the status of the ASP.NET Web API Help Page system?

Created on 6 Feb 2016 · 5Comments · Source: dotnet/aspnetcore

The last release was Microsoft ASP.NET Web API 2.2 Help Page 5.2.3, which was released on 2/9/2015. ASP.NET Core 1.0 is a completely different animal, and the existing Help Page system doesn't work in a self host environment. Has this project been abandoned? If not, is it on the road map?

Source

ghost

Most helpful comment

Swagger/ Swashbuckle is a large step backwards IMO.

The UI is much heavier and more difficult to style
It requires unnecessary decorations (and will literally fail your entire application if one isn't where it's expected) in the endpoints
It's a pain in the butt to customize with app-specific features (like authorization roles/ policies, or special notes)
Object drilldown support is poor
XML documentation support is poor (only the basic summary and params, ignores _seealso_ references)

How difficult would it be to retrofit the original help pages to .NET Core?

jholovacs on 3 Apr 2017

👍6

All 5 comments

In ASP.NET Core MVC we're promoting using API description standards such as Swagger/Swashbuckle, which MVC helps enable using its new ApiExplorer API. We have a sample site that shows a few things you can do with ApiExplorer. And also check out https://github.com/domaindrivendev/Ahoy for a project that uses ASP.NET Core MVC to produce API metadata descriptions.

cc @rynowak

Eilon on 6 Feb 2016

Hey Eilon,

That's AWESOME news! I'll take a look at it. If it is somewhat similar to the auto-generated legacy web service information pages, or a hybrid of them with the Web API Help Pages, I'd really be ecstatic.

Again, Thank you very much for the quick response...

ghost on 6 Feb 2016

@Kaelum I'd wager it's a bit fancier in the sense that it targets an established standard, so there is more opportunity for a bright future and various clients to consume the data and produce a rich UI.

Eilon on 6 Feb 2016

Swagger/ Swashbuckle is a large step backwards IMO.

The UI is much heavier and more difficult to style
It requires unnecessary decorations (and will literally fail your entire application if one isn't where it's expected) in the endpoints
It's a pain in the butt to customize with app-specific features (like authorization roles/ policies, or special notes)
Object drilldown support is poor
XML documentation support is poor (only the basic summary and params, ignores _seealso_ references)

How difficult would it be to retrofit the original help pages to .NET Core?

jholovacs on 3 Apr 2017

👍6

This issue is being closed because it has not been updated in 3 months.

We apologize if this causes any inconvenience. We ask that if you are still encountering this issue, please log a new issue with updated information and we will investigate.