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
7
votes
1 answer

Web Api Help Page - all are missing

In my source code documentation I often use: Get a for the specified object. And this translates nicely into the below string in the XmlDocument.xml, which contains the compiled web api help pages. Get a…
Remy
  • 12,555
  • 14
  • 64
  • 104
7
votes
1 answer

Documenting descriptions on Complex Types

Within my API I'm trying to document the different field descriptions, however none of attributes seem to work. I know this functionality is supposed to have been recently implemented within WebAPI 5.1 (running WebAPI.HelpPage 5.1.2). ASP.Net Web…
wonea
  • 4,783
  • 17
  • 86
  • 139
7
votes
1 answer

Are XML documentation tags not being handled by Web API 2 help pages?

I'm trying to use tags in my XML documentation tags for my API, but they are coming up blank in the Help pages. So, for a Description I'd like it to say: "Gets or sets the value for the associated Item." Where Item is a link to…
Chris Paton
  • 5,113
  • 4
  • 41
  • 52
6
votes
1 answer

ASP .NET 5 WEB API creating help page

I just got started working on ASP.NET 5. I want to have a help page for my methods, I have seen few examples for creating help pages but most of them are MVC specific. I have gone through Microsoft.AspNet.WebApi.HelpPage package, it creates an Area…
user1586570
  • 87
  • 1
  • 1
  • 4
6
votes
2 answers

Web API Help Page for method with Enum parameters

I'm generating my API documentation with Web API Help Page generator. But the problems is that the Help Page generator can't generate the documentation for methods with Enum parameters. This also occur with parameters of object and dynamic…
user1938667
5
votes
1 answer

Modifying the Introduction on the Web API help page

I've enhanced an older SOAP style web service with REST endpoints. Most everything is working correctly, but I haven't been able to figure out how to change the Introduction on for the auto generated help files. What I have right now is showing…
user2197446
  • 1,065
  • 3
  • 15
  • 31
5
votes
1 answer

Web API Help Pages always empty

I've added Help pages Nuget package to create documentation for my Web API but it doesn't work for me, no API methods are shown. I uncommented line : config.SetDocumentationProvider(new…
goran85
  • 503
  • 5
  • 19
5
votes
0 answers

Which XML comment tags Microsoft ASP.NET Web API Help Page should I use on a controller methods?

I am trying to build API documentation for a RESTful web service using Microsoft ASP.NET Web API 2.2 Help Page 5.2.3. It looks like the contents of the and elements get included in the documentation, but the section is…
Alek Davis
  • 10,628
  • 2
  • 41
  • 53
5
votes
1 answer

Setting Help Page as default route

I have a C# .Net 4.5 Web Api application to which I have added a Help Page such as the one shown here. When a developer launches the Web Api application in Visual Studio, I would like the help page to come up. I would like to accomplish this by the…
A Bogus
  • 3,852
  • 11
  • 39
  • 58
5
votes
0 answers

How to add Multipart Form Data parameter on WebAPI help page

Please help me to add a multipart/form data parameter on api help page. I'm using Microsoft.AspNet.WebApi.HelpPage.VB 5.2.2. I want to add CustomerName, fdStreet1, fdStreet2 parameter information on to the api help page. How can I do this? Here's…
G.S. Shekhawat
  • 339
  • 4
  • 13
5
votes
1 answer

How to make ASP.NET WEB API HELP PAGES Xml Documentation Comments to have new line

I have a rest api developed using ASP.NET WEB API. I used help pages nuget package in order to create documentation. One problem I encountered is the following. For my model objects, I have xml documentation comments and they become descriptions on…
neo
  • 1,952
  • 2
  • 19
  • 39
5
votes
0 answers

Document Request & Response Headers in WebAPI

I've developed a WebAPI service which passes Request & Response headers for each controller (globally). Does the WebAPI HelpController support documentation of these, through HttpResponseMessage and Requests? Example Request Headers; Content-Type:…
wonea
  • 4,783
  • 17
  • 86
  • 139
5
votes
1 answer

Web Api - Auto generating request samples using ApiExplorer

Is there a way to make ApiExplorer auto generate request samples? I tried using: config.SetActualResponseType(typeof(SomeType), "ControllerName", "Post"); in HelpPageConfig.cs, but 2 problems came up: it requires me to define specific types for…
lxngxr
  • 127
  • 1
  • 6
4
votes
3 answers

VS 2017 WebAPI Help Page - No Document Provided

I have followed the steps at MSDN, and other SO questions, to setup documenting and to have the XML comments show in the descriptions section of the help page. However, I am receiving errors when I try to build or run the project. Visual Studio 2017…
bPuhnk
  • 375
  • 2
  • 11
4
votes
2 answers

Web API Help Pages not loading documentation XML

I'm trying to set up the ASP.NET Help Pages to run in an existing MVC project, though pointing towards the documentation file from a Web API project in the same solution. Convention has the Help Pages running inside the Web API that it's documenting…
awj
  • 7,482
  • 10
  • 66
  • 120
1
2
3 4 5 6 7 8