Stack Overflow
Stack Overflow

Questions tagged [asp.net-mvc-apiexplorer]

ASP.NET MVC.ApiExplorer is a portable, independent component designed to help you explore all actions of controller in an ASP.NET MVC project.

ASP.NET MVC.ApiExplorer is a portable, independent component designed to help you explore all actions of controller in an ASP.NET MVC project. ASP.NET MVC.ApiExplorer can be installed from the NuGet gallery and its source code is available on Bitbucket.

34 questions
24
votes
2 answers

ASP.NET Web API Generate all parameters from model - help pages

I'm busy creating a Web API (Inside a asp mvc4 application). I am using the library suggested on the asp.net site for generating documentation (http://www.asp.net/web-api/overview/creating-web-apis/creating-api-help-pages). My problem is that if my…
Jeandre Pentz
  • 992
  • 2
  • 9
  • 20
14
votes
3 answers

ASP.Net Web Api - ApiExplorer does not contain any ApiDescriptions

I am trying to implement an Options method in a controller of my web service that will return a message containing the valid HTTP methods for the URI endpoint associated with the controller. My Options method looks something like this: public…
Jeremy G
  • 568
  • 4
  • 18
10
votes
2 answers

Valid routes not discovered by MVC.ApiExplorer

When using ASP.NET Web API Help Page and the related MVC.ApiExplorer I have valid routes that are accessible via http yet aren't discovered by ApiExplorer. These routes are only found when a general routing rule is used. Usage of a more specific…
rheone
  • 1,517
  • 1
  • 17
  • 30
7
votes
3 answers

Custom ApiExplorer with Namespace based ApiControllers

I'm trying to add API documentation at my backend system. Default ApiExplorer and Help page worked absolutely great until the moment I introduced versions to my Api Controllers. In order to add versions I created sub folders under the Controllers…
Mando
  • 11,414
  • 17
  • 86
  • 167
5
votes
1 answer

How to add healthcheck endpoint to ApiExplorer so that Swashbuck includes it in the generated swagger.json

I've added Microsoft.AspNetCore.Diagnostics.HealthChecks style health checks to my application as documented by Microsoft here. I am also using Swashbuckle to generate a swagger document. I then use NSwag to generate a client API for my other…
br3nt
  • 9,017
  • 3
  • 42
  • 63
5
votes
1 answer

Web Api - Auto generating request samples using ApiExplorer

Is there a way to make ApiExplorer auto generate request samples? I tried using: config.SetActualResponseType(typeof(SomeType), "ControllerName", "Post"); in HelpPageConfig.cs, but 2 problems came up: it requires me to define specific types for…
lxngxr
  • 127
  • 1
  • 6
4
votes
2 answers

Is ApiExplorer supported in ASP.NET Core 1.0, and how to use it?

Does ASP.NET Core 1.0 support the use of APIExplorer? I'm unable to find any docs on it or how to use it, has anyone used it and can share some insight?
Andrej Kikelj
  • 800
  • 7
  • 11
4
votes
1 answer

ASP.NET WebAPI - How to scan registered Actions

I have several methods in my WebApi which return HttpResponseMessage. As the response type is unknown, I have to register them in HelpPageConfig using something like config.SetActualResponseType(typeof(X), "SomeController", "GetX"); I would like…
mcintyre321
  • 12,996
  • 8
  • 66
  • 103
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
3
votes
0 answers

Web Api 2 help documentation generator

I have installed Microsoft.AspNet.WebApi.HelpPage to my web api 2 project and can successfully output the /help pages. One thing i cant seem to get going however is getting it to generate the xml comment documentation i have added to classes that…
AdrianSean
  • 397
  • 1
  • 5
  • 21
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
1 answer

WebAPI APIExplorer Documentation does not pick up my Summaries comments

Using http://www.asp.net/web-api/overview/creating-web-apis/creating-api-help-pages documentation guide and applied these on each public API controllers /// /// My own description comments /// but somehow NONE of my…
SF Developer
  • 5,244
  • 14
  • 60
  • 106
3
votes
1 answer

WebApi ApiExplorer ApiExplorerSettingsAttribute and IgnoreApi for Action Parameters

You can decorate a controller or action method with the ApiExplorerSettingsAttribute setting the IgnoreApi property to NOT generate help info. If you try to apply the same to an action method's attribute, you get an error: public…
Dzejms
  • 3,108
  • 2
  • 30
  • 40
3
votes
1 answer

ASP.NET Web API: calling ApiDescriptions on a ApiExplorer throws: This method cannot be called during the application's pre-start initialization phase

Based on this blogpost http://codebetter.com/johnvpetersen/2012/08/01/documenting-your-asp-net-web-apis/ I'm writing a "documentation-controller", pretty much as it's done in the above link. However when I make the following call…
Andreas
  • 5,501
  • 2
  • 20
  • 23
2
votes
0 answers

Web API, model binding, [FromUri], and WebApiExplorer not playing well together

I have a fairly simple web api project and have the following method in a CustomerController: public class CustomerController : ApiController { [HttpGet] public UpdatePasswordResult UpdatePasswordWithUserCode([FromUri]…
Buchannon
  • 1,671
  • 16
  • 28
1
2 3