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

Exclude HelpPage from WebAPI C#

i need to exclude my api help page during release mode i tried to add ApiExplorerSettingsAttribute().IgnoreApi = true in webapi config file but it's of no use how can we achieve it?
Logeswaran D
  • 127
  • 1
  • 7
0
votes
1 answer

Web API Help page with cross authentication identity from other site

SCENARIO I've a site in IIS with two applications. The principal ("A") is a REST service made with Web API 2 in C#, that contains inside an Areas folder with an autogenerated Help Page ("B"). "A" uses a header authorization, not with forms…
Leandro Bardelli
  • 10,561
  • 15
  • 79
  • 116
0
votes
0 answers

Error When Web API Help Tries to Deserialize Microsoft Azure AD Graph API Group

When I try to access the Help Area for my Web API 2 application, the HelpPageSampleGenerator is throwing an exception in the WriteSampleObjectsUsingFormatter method in the last line of the quoted code below when trying to deserialize a Group from…
JustinC
  • 1
  • 1
  • 1
0
votes
1 answer

asp.net help page does not show right routes

I am using attribute routes to route actions in controllers, but asp.net generate wrong Help Page [HttpGet] [Route("getAll")] [AllowAnonymous] public IHttpActionResult GetCategories(){...} But the result is
Andrew Snigur
  • 133
  • 9
0
votes
2 answers

ASP.Net HelpPages not showing my controllers

I have been here before, but this time I have managed to get further than I have before. I have been following this guide and done everything it has said. If I navigate to http://localhost:61589/help I actually see the help page, but there is only…
r3plica
  • 13,017
  • 23
  • 128
  • 290
0
votes
1 answer

Put the Web Api Documentation behind a login page so that only valid user can browse the Web Api help documentation

We have created a web api project in which we have used Basic authentication for time being. We have used the nuget package to generate the Web Api help documentation, so it has added new area, controller and views for Web Api Help. We have hosted…
Mehul Vaghela
  • 478
  • 4
  • 20
0
votes
1 answer

Duplicate api's listed by the help page

I am using the webapi help pages nuget package from Microsoft. When i recently added a new controller, all my routes in the help page appear twice: GET api/v2/something/{id} and GET api/v2/something?id={id} How can i remove these…
zaitsman
  • 8,984
  • 6
  • 47
  • 79
0
votes
1 answer

WebAPI - auto generate documentation with all possible responses

I have read an article http://www.asp.net/web-api/overview/getting-started-with-aspnet-web-api/creating-api-help-pages and it works fine. But I would prefer to add all possible responses and conditions, when these responses will be sent. Any tool to…
Oleg Sh
  • 8,496
  • 17
  • 89
  • 159
0
votes
2 answers

TFS 2013 Web Deploy and web API help pages

I am using Team Foundation Server 2013 and have the nightly build configured to deploy a web application. The web application is making use of the web API help pages which depend on the built in XML documentation files. I currently have these XML…
seanzi
  • 883
  • 10
  • 24
0
votes
0 answers

Web API documentation generator throwing error with serialised string

I have an object that has a parameter that is a list of integers. In order for this object to behave nicely with Entity Framework and be saved in SQL, I have a calculated property that serialises that string. private IList…
RamblerToning
  • 926
  • 2
  • 13
  • 28
0
votes
1 answer

How to make WebApi HelpPage recognize model documentations located outside the WebApi project itself

Let's say I have two project in one solution WebApi: A WebApi project that provides access points for all api services Core: A library project where business Logic defined here, including system model. For each WebApi request, it uses ModelState…
Luke Fan
  • 143
  • 1
  • 10
0
votes
1 answer

Doesn't display field with array in object

I use the Help Pages for ASP.NET Web API. But I found issue with object as request model. public IHttpActionResult Get([FromUri] PagedRequest request) And the class public class PagedRequest : PagedRequest { public int[] LocationIds {…
Mediator
  • 14,951
  • 35
  • 113
  • 191
0
votes
1 answer

How to properly add comments to generated class properties?

I have some classes generated by EF out of an Oracle database. Those class will be used to build a restful Web API with Help Pages. I wonder how do I add comments to the properties for those generated classes. I can edit those generated class files,…
Ray Cheng
  • 12,230
  • 14
  • 74
  • 137
0
votes
1 answer

Documenting API model response model

I'm documenting an API and I'm wondering how to link the response format to the ViewModel I've created. The ViewModel has annotations which I want the user to browse. The problem being my controller returns HttpResponseMessage not the actual model…
wonea
  • 4,783
  • 17
  • 86
  • 139
0
votes
1 answer

ASP.NET Web API Help Page with markdown comments

I use asp.net WebApi Help Page to generate the document from comments of source code. And I have used doxygen to generate the document before. The doxygen can parse markdown syntax in the comments and output the well formatted documents. But the…
AechoLiu
  • 17,522
  • 9
  • 100
  • 118
1 2 3 4 5 6
7
8