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

ASP.NET web.api Help Page does not show any description

When I run my program it only shows "Provide a general description of your APIs here." But no content is show. Like in this picture: https://i.stack.imgur.com/unBmb.png My problem is similar to this ASP.NET Web Api Help Page doesn't show any tips…
Erik Sellberg
  • 511
  • 1
  • 9
  • 23
4
votes
0 answers

exporting Microsoft.AspNet.WebApi.HelpPage

I'm using the nuget package Microsoft.AspNet.WebApi.HelpPage in VS2012. I'm wondering if there's any export posibility to create a .chm/word/pdf/etc Thanks. Guillermo.
polonskyg
  • 4,269
  • 9
  • 41
  • 93
4
votes
2 answers

Web API Help Pages and API Explorer returning 0 descriptions

I have this project that is just a Web API project. At some point in the past I removed the HelpPages and I made the app use OWIN. Now I have been asked to add API HelpPages back in which I have done. I have set my Startup class to look a bit like…
r3plica
  • 13,017
  • 23
  • 128
  • 290
4
votes
1 answer

Customizing the "Resource Description" section of a ASP.NET Web API help page

I'm using ASP.NET Web API and it conveniently automatically generates documentation for my API, but some of it doesn't make sense. Take the below screenshot as an example. This is an endpoint to GET a user by their ID, and in the Resource…
John Dorean
  • 3,744
  • 9
  • 51
  • 82
4
votes
2 answers

Web API routing and a Web API Help Page: how to avoid repeated entries

I am getting repeat entries rendered in my Web API Help Page with different parents, such as these, that refer to the same method: GET api/{apiVersion}/v1/Products - Gets all products ... GET api/v1/Products - Gets all…
Patrick Szalapski
  • 8,738
  • 11
  • 67
  • 129
4
votes
2 answers

Resource Description on Web API Help page is showing "None."

I'm having trouble figuring out how to get the Help page in my Web Api to show anything for Resource Description other than None. It has IHttpActionResult linked and then "None." after that. I got my samples working by adding…
dkiefer
  • 501
  • 5
  • 13
4
votes
1 answer

ASP.NET Web API Help Pages and Versioning

I would like to create a separate help page for each version of my API. For example, the user could go to /help?v=1 to see version 1.0 routes and /help?v=2 to see version 2.0 routes. Using SDammann.WebApi.Versioning, I added a Version property to…
Irving
  • 1,257
  • 2
  • 16
  • 28
4
votes
1 answer

ASP.NET Web API Help Page generates incomplete documentation for F# record types

The ASP.NET Web API Help Page project does not produce complete documentation for F# record types used as parameters or result types for Web API controller actions. Members are listed, but summary information in XML comments is not displayed in the…
Jordan Gray
  • 16,306
  • 3
  • 53
  • 69
4
votes
1 answer

WebAPI Help Pages doesn't show all endpoints for OData controller

I added Help Pages component for my ASP.NET MVC Web API with OData. To make it working I had to specify [ApiExplorerSetting(IgnoreAPI = false)] explicitly. However, it shows default GET endpoint only, like: api/Customers. But my API also supports…
Yuriy Frolov
  • 301
  • 1
  • 3
  • 10
4
votes
1 answer

Extending webapi 2.1's help page to include additional data

I found a pretty dated post from Yao at microsoft advanced help page customizations I have tried to implement the steps however I am unable to get my custom comment to display within the help documentation. Within my …
Diver Dan
  • 9,953
  • 22
  • 95
  • 166
4
votes
2 answers

Web API Help Pages - Order controllers by route prefix

Since areas are not easily supported in Web API (and also because I need more flexibility than project-wide routing rules), I am using the [RoutePrefix] attribute on my controllers to group my Web API controllers into namespaces,…
mayabelle
  • 9,804
  • 9
  • 36
  • 59
4
votes
2 answers

WebAPI Help Page - Documentation for return or parameter model/class properties

I am using Web API Help Page with Web API 2 (5.0) - both the latest Nuget packages. I would like the help documentation to show the comments of the properties on classes that are parameters or returned in the body of the HttpResponseMessage. For…
mayabelle
  • 9,804
  • 9
  • 36
  • 59
4
votes
1 answer

Restricting auto Help Page contents when using Attribute Routing in Web API 2

I'm currently implementing a Web API using Web API 2's attribute routing (http://www.asp.net/web-api/overview/web-api-routing-and-actions/attribute-routing-in-web-api-2). I am also using the Help Pages module in order to automatically generate…
jmsb
  • 4,846
  • 5
  • 29
  • 38
3
votes
2 answers

Empty model property description on ASP.NET Web API Help Pages

Introduction I've followed this tutorial to setup my ASP.NET Web API Help Pages. Using The documentation seems to be fine, but I'm getting empty model…
Maximiliano Ejberowicz
  • 165
  • 1
  • 13
3
votes
6 answers

How to handle path on azure for XmlDocumentationProvider

I am using azure for deployment of my new Web API's, I am new with deployment on IIS and azure. I have added my Web API's on azure as web application, and it's working fine, till I added documentation for each API's functions. After adding…
Keval Patel
  • 925
  • 4
  • 24
  • 46
1 2
3
4 5 6 7 8