Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create help pages for web api controllers #55

Closed
hikalkan opened this issue Aug 15, 2014 · 6 comments

Comments

@hikalkan
Copy link
Member

commented Aug 15, 2014

It can be a good idea to generate help pages from comments (summary) of web api controller methods. It might be done with toold like NDoc but this may be considered as a simple and dynamic way of generating help pages.

@hikalkan

This comment has been minimized.

Copy link
Member Author

commented Sep 3, 2014

We can get it from X.dll.xml file (see http://jimblackler.net/blog/?p=49) or define special classes/interfaces/attributes for that.

@babinecm

This comment has been minimized.

Copy link

commented Mar 2, 2015

I tried to generate Web API Help Page through the default ApiExplorer (http://www.asp.net/web-api/overview/getting-started-with-aspnet-web-api/creating-api-help-pages).
The problem is that ApiExlporer automatically creates help pages for "AbpServiceProxies" and "ServiceProxies" controllers. I think that these controllers for dynamic api methods should not be exposed in help pages.
Is it possible to add "[ApiExplorerSettings(IgnoreApi=true)]" attribute to both classes "AbpServiceProxiesController" and "ServiceProxiesController"?

@hikalkan hikalkan added this to the ABP v1.0.0 milestone Mar 20, 2015
@hikalkan

This comment has been minimized.

Copy link
Member Author

commented May 6, 2015

See also SwaggerUI/Swashbuckle for that.
http://forum.aspnetboilerplate.com/viewtopic.php?f=2&t=136

@echofool

This comment has been minimized.

Copy link

commented Aug 28, 2015

I was going crazy! After add override method 'GetActionMapping' for 'AbpApiControllerActionSelector' and 'GetControllerMapping' for 'AbpHttpControllerSelector' i was so excited that ,i can see my dynamic api help pages.But when i had add more than one method(all post) in my service class , help pages for dynamic apicontrollers are gone, even thought my dynamic api steel callable, then i guess these may cause by 'ApiExplorer'(ApiExplorer.InitializeApiDescriptions), Is there anyone else who can help me?

@hikalkan hikalkan modified the milestones: After ABP v1.0.0, ABP v1.0.0 Jan 9, 2016
@baiyunchen

This comment has been minimized.

Copy link

commented May 28, 2017

Can not use the GroupName property in the ApiExplorerSettingsAttribute in the dynamic API?

@acjh

This comment has been minimized.

Copy link
Contributor

commented Mar 10, 2018

Swagger UI Integration is now supported via Swashbuckle.

@acjh acjh closed this Mar 10, 2018
@hikalkan hikalkan removed this from the Backlog milestone May 9, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
5 participants
You can’t perform that action at this time.