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
27
votes
2 answers

ASP.NET Help Pages default home page?

I want to go to http://myserver and be able to get Help Pages as the default home page, so the first thing a guest to http://myserver should see is the Help Page. I have a default route set up like this: public static void…
Gaui
  • 8,723
  • 16
  • 64
  • 91
22
votes
4 answers

Web Api Help Page XML comments from more than 1 files

I have different plugins in my Web api project with their own XML docs, and have one centralized Help page, but the problem is that Web Api's default Help Page only supports single documentation file new…
Levan
  • 642
  • 1
  • 6
  • 14
19
votes
2 answers

Can't get ASP.NET Web API 2 Help pages working when using Owin

I've installed the correct package for Web Api 2 Install-Package Microsoft.AspNet.WebApi.HelpPage -Pre But the help area is not being mapped and is returning 404 (Web Api working fine). I'm using Microsoft.Owin.Host.SystemWeb as the host. Below…
DalSoft
  • 10,673
  • 3
  • 42
  • 55
18
votes
2 answers

WebApi Help Page: don't escape HTML in XML documentation

I am using XML Documentation for my ASP.NET Web API Help Page as shown here. I would like to know if there is a way to include html in the comments such that it will be rendered on the web page, instead of it being…
sǝɯɐſ
  • 2,470
  • 4
  • 33
  • 47
15
votes
6 answers

WebAPI Help Pages: disable for Production release

I have developed a number of internal REST interfaces using the older WCF framework in VS 2010. The ability for it to generate help pages was handy for DEV and QA platforms, but for a production release it was easy to disable the generation of these…
GoodEnuf
  • 643
  • 1
  • 7
  • 10
15
votes
3 answers

"Access is denied" on build server when deploying Web API project with XML documentation

In order to generate XML documentation using Web API Help Pages for my Web API project, I had to check the "XML documentation file" option under the "Builds" section of my project's properties. This correctly generates the documentation when I build…
mayabelle
  • 9,804
  • 9
  • 36
  • 59
12
votes
2 answers

ASP.NET Web API Help page under separate project

I have ASP.NET Web API project and I want to add a Help page, but I want it to be in a separate project. Is it possible ?
koryakinp
  • 3,989
  • 6
  • 26
  • 56
12
votes
4 answers

How to generate JSON Postman Collections from a WebApi2 project using WebApi HelpPages that are suitable for import

Postman is a tool that can be used to easily test restful web services. If an Asp.Net project is using WebApi in conjunction with WebApi Help pages documentation can be automatically generated for exposed restful web services. This autogenerated…
rheone
  • 1,517
  • 1
  • 17
  • 30
10
votes
3 answers

Web API Help pages - customizing Property documentation

I have my web api and I added the web api help pages to auto-generate my documentation. It's working great for methods where my parameters are listed out, but I have a method like this: public SessionResult PostLogin(CreateSessionCommand…
Josh
  • 16,286
  • 25
  • 113
  • 158
9
votes
3 answers

StructureMap Exception after adding the WebApi.HelpPage to a webApi project

I followed the instructions here to add the webApi.HelpPage area and views to an existing project, which uses structureMap - but when accessing the /Help url: StructureMap Exception Code: 202 No Default Instance defined for PluginFamily…
nathfy
  • 687
  • 1
  • 9
  • 11
8
votes
2 answers

ASP.Net web API Help Page - no content

I installed the package from NuGet, uncommented the line from HelpPageConfig.cs- config.SetDocumentationProvider(new XmlDocumentationProvider(HttpContext.Current.Server.MapPath("~/App_Data/XmlDocument.xml"))); I've set the same file under…
Sirguley Von-Tuck
  • 81
  • 1
  • 2
8
votes
1 answer

ASP.NET Web API Help Page can't process Generic Type Controller

I have a question about ASP.NET Web API HelpPages. Usually HelpPages can generate the WebAPI by XMLDocumentation Sample Code: public class ValueControllerBase : ApiController { /// /// Base Do /// public…
user3764380
  • 81
  • 4
8
votes
1 answer

How do I document an optional QueryString parameter in ASP.NET WebApi Help Pages?

The ASP.Net Web Api Help Pages seem to automatically determine if a parameter is in the Request Uri or Body. How can I document option parameters that are QueryString parameters? For example I have may have a RESTful Url such as [GET]…
Justin
  • 10,667
  • 15
  • 58
  • 79
7
votes
2 answers

How to display parameter in Web API help page documentation for Response only?

I've configured Web API help page documentation. I am having below class which would be inherited in other model classes. public class ResponseBase { public string ErrorReason { get; set; } [IgnoreDataMember] public bool IsRejected {…
Nilesh Thakkar
  • 2,877
  • 1
  • 24
  • 43
7
votes
1 answer

Web API Help page not showing XML

I have a Web API project in which I removed by hand Areas folder few months ago when we started development. Now after everything is finished I want to add API help pages but it is not working as expected. I installed nuget package for help pages. I…
goran85
  • 503
  • 5
  • 19
1
2 3 4 5 6 7 8