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

Enable HelpPages when using OWIN Katana

I can get the help pages to render using the traditional asp.net engine, but how can I get the same thing when hosting the Web API service on OWIN/katana. I tried adding HelpPageConfig.Register(config); to class Startup to no avail.
Alwyn
  • 8,079
  • 12
  • 59
  • 107
2
votes
1 answer

Web API help page duplicating Action for all areas

I'm working with Web API 2, and it seems to pull up my existing API calls already, except it's duplicating all the calls for each area that i have. For example, say i have 3 areas, and in one of those i have an API call that looks like: public…
Phil
  • 1,852
  • 2
  • 28
  • 55
2
votes
0 answers

OWIN Middleware kills WebApi.Helppage

I have a ASP.NET WebApi Project that uses Microsoft.Asp.Net.WebApi.HelpPage nuget project (version 5.2.2) When adding app.UseWebApi(config); to the startup.cs when I try and access a method on the help I get the following error: This method or…
Franklin
  • 589
  • 1
  • 4
  • 20
2
votes
0 answers

Web API Help Page with template classes

I have a ASP.NET Web API which returns a template class but I can't get the Web API Help Page to provide documentation for the return type correctly. Let's say I have the following Model classes: public class MyType { /// A list of…
m__
  • 1,721
  • 1
  • 17
  • 30
2
votes
1 answer

How to add help in Web API for external library classes

Good morning, I have a solution consisting of two projects. One is a class library, containing common classes that will be used in other projects. The other is a WebAPI 2.1 project. I am generating the help files for the API by using the automatic…
user176504
  • 183
  • 1
  • 1
  • 10
2
votes
0 answers

WebAPI help pages DTD or XSD schema file generation

Is it possible to create DTD or XSD files for a WebAPI project from WebAPI Help Pages. I'm using WebAPI Help Pages to document the request and response models, but I was after producing more formal definition documents.
wonea
  • 4,783
  • 17
  • 86
  • 139
1
vote
0 answers

ApiExplorer not showing methods from controller with ParameterBindingAttribute

I'm using ASP.NET Web API Help Page for my web API, but unfortunately controller method's that uses ParameterBindingAttribute are not being listed on GetApiExplorer(). Example bellow GetOutPut is listed and GetEntrance not. public HelpController() :…
rcarvalhoxavier
  • 331
  • 5
  • 7
1
vote
0 answers

Web API Help page doesn't show documentation of extended object

Tldr; I have a object that extends from another object. /// /// Represents the result of an operation /// [DataContract] public class ApiResult : ApiResult { /// /// The requested data /// …
Christian Gollhardt
  • 16,510
  • 17
  • 74
  • 111
1
vote
1 answer

How to ignore parameters in asp.net web api help page which are generated automatically from routing and from action

One of my action parameters is instance of class which have param1, param2, param3 parameters (with [FromUri] attribute and I can't replace it with [FromBody]) And that parameters are in routing too. When asp.net web api help page generates…
Aren
  • 11
  • 2
1
vote
1 answer

The route template separator character '/' cannot appear consecutively when adding action to default route

I have a Web API 2 project hosted through an OWIN middleware. Everything worked perfectly fine and I am able to call my APIs as expected. But, my WebApiConfig defines the default route as follows: config.Routes.MapHttpRoute( name: "DefaultApi", …
Kassem
  • 8,116
  • 17
  • 75
  • 116
1
vote
0 answers

C# Web API Help Page - Additional Information for the Body Parameters shows "None."

I am using the Microsoft ASP.Net Web API 2.2 Help Page version 5.2.3 and the additional information for the Body Parameters is showing "None". I have not been able to make it show any useful information. The other information is populated…
CWeaver
  • 41
  • 2
  • 9
1
vote
2 answers

Cannot Access the Help Pages in WebAPI Project which is deployed inside MVC Application in NopCommerce

I have been working in nopcommerce and trying to implement the Web API Restful services for client application. I have added a Web Api Project and set the output directory of my WebAPI Project to the main startup project which is the Nop.Web…
user1971051
  • 63
  • 3
1
vote
0 answers

ASP.Net Web Api Help page moved to another project

I have a WebApi Service with a Help Area. For security reasons, I need to move this MVC Help Area to another MVC Project in the same solution. How can be achieved this? I understand that the API info is getting by an XML File, but is just move the…
Leandro Bardelli
  • 10,561
  • 15
  • 79
  • 116
1
vote
1 answer

WebApi documentation not recognizing endpoints

I have multiple controller endpoints with routes like this: [Route("api/myobjects/action1/action2/{objectIds}")] They all have method signatures like this (access modifier and return type…
transporter_room_3
  • 2,583
  • 4
  • 33
  • 51
1
vote
0 answers

How to put Header in web api help page Areas

I hit one api call on the server in which i pass header Content-type. Now on the web api help page Documentation want to show that this Headers are passed when web api call is made Put below code for Documentation on the method. but how to pass…
Dhruti
  • 31
  • 7
1 2 3 4
5
6 7 8