Stack Overflow
Stack Overflow

Questions tagged [asp.net-web-api-helppages]

The ASP.NET Web API Help Page automatically generates help page content for the web APIs on your site.

"The ASP.NET Web API Help Page automatically generates help page content for the web APIs on your site… Everything generated by the help page is fully customizable using ASP.NET MVC and Razor. ASP.NET Web API Help Page is a great addition to any ASP.NET Web API project."

—NuGet summary

For more information on how to use the ASP.NET Web API Help Page, you can start with this tutorial from the Microsoft Web API site; more advanced usage scenarios are outlined at Yao Huang's blog on MSDN.

109 questions
1
vote
2 answers

How do I only display methods that belong to a controller specified by the URL

I am working on customizing the ASP.NET Web API help pages. I am looking for the best approach to display methods that belong to a controller specified by the URL. My controllers are all prefixed with "ws_". I have added an entry to my…
Danny Graham
  • 78
  • 8
1
vote
1 answer

How do I connect an XML comment to an API help page?

I am working on a project that requires documentation on an API Help page. The page is already created, and it is ready for information to be inserted. But I have some issues: I am very new to this, so I am having some issues navigating through the…
Jonathan Sullivan
  • 11
  • 1
  • 2
1
vote
1 answer

ASP Web API Help pages - Links to other pages

I am using Web API help pages and I would like to be able to include links to other methods. I have seen from Are XML documentation tags not being handled by Web API 2 help pages? that using isn't supported. Are there any better…
Stuart Moore
  • 681
  • 5
  • 32
1
vote
0 answers

Extending Help Pages for ASP.NET Web API to support versioning

I am just wonder if there is any package or extension to Web API help pages to support versioning other than SDammann package. I want to have something like this [MinVersion("1")] public string Get(int id) { return "value"; …
Samuel Gerges
  • 251
  • 3
  • 10
1
vote
2 answers

Web Api Help Page - Redirect to MVC help page

I've a Web Api Service in C# and I created a Help Page, that added a folder "Areas" with a MVC project. I tried to make my SERVICE/help page into my default page, changing the controller on the routing but of course, I couldn't do it because "help"…
Leandro Bardelli
  • 10,561
  • 15
  • 79
  • 116
1
vote
1 answer

Generating REST MVC5 API documentation using WebApi.HelpPage

I have an API which I need to produce documentation for. I've used the following article to setup the documentation on my API and it's working pretty well. I'm using the: Microsoft.AspNet.WebApi.HelpPage NuGet package to generate documentation for…
Captain John
  • 1,859
  • 2
  • 16
  • 30
1
vote
1 answer

WebApi2 Help Page stops generating documentation after extending ApiController

I have extended ApiController to include some common properties/methods, and this extended controller is held in a separate class library/assembly. public class ExtendedApiController : ApiController { // shared properties... } In my Api…
nak5ive
  • 1,963
  • 4
  • 15
  • 21
1
vote
1 answer

Web API Help Page emitting "An item with the same key has already been added"

I have just upgraded my web API help page to version 2.1. When I tried to open the help page, I got this error: [ArgumentException: An item with the same key has already been added.] System.ThrowHelper.ThrowArgumentException(ExceptionResource…
Endy Tjahjono
  • 24,120
  • 23
  • 83
  • 123
1
vote
1 answer

anyone use swagger for web api documentation see this error at runtime?

Please enable "XML documentation file" in project properties with default (bin\EnterpriseServices.XML) value or edit value in App_Start\SwaggerNet.cs
silverArc
  • 938
  • 1
  • 11
  • 19
0
votes
0 answers

dont show help page in web api

I want to create help pages for ASP.NET Web API. I created a new ASP.NET Web application project and select the Web API project template. It added Areas/HelpPage. When I run the application, the home page contains a link to the API help page. From…
ar.gorgin
  • 4,765
  • 12
  • 61
  • 100
0
votes
0 answers

How to format/style /// in Web API 2

Maybe this isn't even possible, but it seems silly that I can't figure it out (nor can find anything conclusive after searching). With a MVC/C# Web API 2 project, your controllers can be documented using something like: /// ///This is…
Ted Krapf
  • 403
  • 3
  • 11
0
votes
1 answer

Is there a way to generate static html pages with Microsoft.AspNet.WebApi.HelpPage?

Currently, thanks to Microsoft.AspNet.WebApi.HelpPage, I'm able to see API help page. But I need to run (or publish and deploy to IIS) that ASP.NET Web application. Does Microsoft.AspNet.WebApi.HelpPage provide any functionality to generate static…
Yeheshuah
  • 1,216
  • 1
  • 13
  • 28
0
votes
1 answer

Web API Help Pages discover API but can't show API description page

I have installed WebApi HelpPages on an existing project. I can see list of API's (including areas api's). But clicking on link just don't work to see details of API. I can't figure what i misunderstand. Api itself work fine at…
stefmex
  • 584
  • 1
  • 6
  • 11
0
votes
1 answer

WebApi HelpPage api detail page 404, when "api" prefix removed?

.net4.7 + WebApi5.23 + HelpPage5.23. My WebApiConfig.Register: public static class WebApiConfig { public static void Register(HttpConfiguration config) { ... config.MapHttpAttributeRoutes(); …
ahdung
  • 350
  • 3
  • 13
0
votes
1 answer

asp.net mvc web api help page not populating for given route

I am having difficulties having the help page populate for a web api controller. The only method in the controller is the following: public HttpResponseMessage Get(string p1,string p2= "blend", string p3 = "blend") The method appears reflected in…
donquijote
  • 1,642
  • 5
  • 19
  • 41
1 2 3 4 5
6
7 8