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

How do I get the xml documentation generated from c# to appear in alphabetical order?

I am writing a web service using Microsoft Web API Controller classes (v2.1) and using XML at the beginning of each class and method to automatically generate the documentation. The generated documentation has a home page listing each class and…
Jim S
  • 1,069
  • 3
  • 10
  • 17
3
votes
0 answers

How to get a list of the implement rules - FluentValidations

Using FluentValidation with WebAPI, I am attempting to show the rules that are implemented on a property. I am using the Microsoft.AspNet.WebApi.HelpPage assemblies that will generate the help pages for my API. I would like to be able to enumerate…
Jerode
  • 490
  • 4
  • 15
3
votes
1 answer

ASP.Net WebApi 2 sample text attribute

Is there a way do provide samples for the web api help pages generation using attributes? I know that I can provide samples by going to /Areas/HelpPage/... but I want them all in one place with my code. Something along these lines: ///…
Slavomír Današ
  • 85
  • 8
3
votes
0 answers

Web API Help page doesn't work with custom route

I have a problem with API help page, it works well until I changed the route of API. Let see this example, I have a booking API for controlling users' booking action: public IEnumerable Get(string token) { return…
jimmy ng
  • 41
  • 3
3
votes
1 answer

Web API Help Pages - User-specific response type

I'm developing an API that outputs a different response based on the user, and I'm currently using the ResponseType attribute to describe the type of response that's returned, but this only allows me to specify one type of response, which will…
Tom
  • 1,561
  • 4
  • 20
  • 29
3
votes
2 answers

Unit Test to ensure only selected HTTP verbs are applicable to WebAPI

Using the WebAPI. One of our tests that had been created was to ensure that for a specific controller, only GET verbs where permitted. A test had been written that used the MVC HelpPages HttpSelfHostConfiguration config = new…
Darren Guy
  • 1,123
  • 2
  • 13
  • 39
3
votes
1 answer

WebAPI ApiExplorer Help page param Additional Information

I'm using MVC4 WebAPI and have some questions; How can we define the "content" of the Parameters page [Additional Information] ?? By default this one states "Define this parameter in the request body" ?? How can we define the sample data on the…
SF Developer
  • 5,244
  • 14
  • 60
  • 106
3
votes
2 answers

ASP.NET Web API Help Pages Omit Controllers That Inherit From A Base Controller

I have a controller that I want to generate documentation for using ASP.NET Web API Help Pages. When I directly inherit from ApiController the documentation appears: public class ExampleController : ApiController But when I inherit from a base…
Fenton
  • 241,084
  • 71
  • 387
  • 401
3
votes
2 answers

Web API Help page showing two versions of every method

How can I avoid the Help page showing both versions of my method? As you can see, I've set up a custom route for /api/property/search/{finnId}, but I don't want the one using query parameters to show up in the Help page. Any way to get around this?…
peirix
  • 36,512
  • 23
  • 96
  • 126
2
votes
2 answers

ApiExplorer does not recognize route attributes with custom type

I have a project where I want to use route attributes with a custom type. The following code where I have the custom type as a query parameter works fine and the help page displays the custom type. // GET api/values?5,6 [Route("api/values")] public…
Troels Agerbo
  • 21
  • 2
2
votes
2 answers

Error when generating help page webapi2

I am getting an error when trying to generate a help page using MVC5 web api2, I know that when generating the project it generates this for you, however I am getting errors now when trying to click on a link System.StackOverflowException was…
Johnathon64
  • 1,280
  • 1
  • 20
  • 45
2
votes
2 answers

Asp.Net Web API documentation tools to support description editing

I'm looking for a documentation tool or generator for asp.net web api application. The tool must allow to edit the description/ summary of the api methods or parameters. I may need this, to allow different teams say PMs, QA to also edit the…
user6382649
  • 31
  • 3
2
votes
3 answers

custom additional information in API documentation

I've read here about additional information of web API help page. The data annotation actually provides the additional information for documentation. But I want to know that is there anyway to provide additional information without data…
Muhammad Omer
  • 111
  • 2
  • 14
2
votes
2 answers

ASP Web API Help pages - Link to class from XML tag

I'm working on Developing a Web-API project, and i'm very impressed with the auto generated documentation by Microsoft's HelpPages. i enabled custom documentation using the official site creating Help Pages the documentation is generated…
Apex ND
  • 440
  • 5
  • 12
2
votes
2 answers

Auto-generating documentation and Inheritence

I have the base API controller: public class BaseController : ApiController { /// /// Method GetByYear in Base class /// /// /// public virtual…
user5246440
1 2 3
4
5 6 7 8