asp.net-web-api-helppages Questions

4

Solved

Postman is a tool that can be used to easily test restful web services. If an Asp.Net project is using WebApi in conjunction with WebApi Help pages documentation can be automatically generated for ...

3

I have followed the steps at MSDN, and other SO questions, to setup documenting and to have the XML comments show in the descriptions section of the help page. However, I am receiving errors when I...
Balkan asked 13/6, 2018 at 18:45

6

Solved

I have developed a number of internal REST interfaces using the older WCF framework in VS 2010. The ability for it to generate help pages was handy for DEV and QA platforms, but for a production re...
Beggary asked 11/6, 2014 at 16:51

2

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....
Krasnoff asked 16/12, 2016 at 7:20

2

Solved

I am using XML Documentation for my ASP.NET Web API Help Page as shown here. I would like to know if there is a way to include html in the comments such that it will be rendered on the web page, in...
Pacify asked 12/3, 2014 at 15:53

1

I have a C# .Net 4.5 Web Api application to which I have added a Help Page such as the one shown here. When a developer launches the Web Api application in Visual Studio, I would like the help pag...

2

Solved

I have ASP.NET Web API project and I want to add a Help page, but I want it to be in a separate project. Is it possible ?

1

I've added Help pages Nuget package to create documentation for my Web API but it doesn't work for me, no API methods are shown. I uncommented line : config.SetDocumentationProvider(new XmlDocume...

2

I've configured Web API help page documentation. I am having below class which would be inherited in other model classes. public class ResponseBase { public string ErrorReason { get; set; } [Ig...
Gerrygerrymander asked 19/2, 2016 at 12:14

1

In my source code documentation I often use: Get a <see cref="Quote"/> for the specified <see cref="apiOrder"/> object. And this translates nicely into the below string in the XmlDoc...
Meliamelic asked 17/6, 2014 at 16:32

1

I've enhanced an older SOAP style web service with REST endpoints. Most everything is working correctly, but I haven't been able to figure out how to change the Introduction on for the auto generat...
Valentino asked 3/3, 2016 at 21:7

1

I just got started working on ASP.NET 5. I want to have a help page for my methods, I have seen few examples for creating help pages but most of them are MVC specific. I have gone through Microsoft...
Sumatra asked 1/12, 2015 at 8:22

4

Solved

I have different plugins in my Web api project with their own XML docs, and have one centralized Help page, but the problem is that Web Api's default Help Page only supports single documentation fi...
Excommunicative asked 4/3, 2014 at 7:37

2

I installed the package from NuGet, uncommented the line from HelpPageConfig.cs- config.SetDocumentationProvider(new XmlDocumentationProvider(HttpContext.Current.Server.MapPath("~/App_Data/XmlDocu...
Damico asked 25/8, 2015 at 6:58

3

Solved

In order to generate XML documentation using Web API Help Pages for my Web API project, I had to check the "XML documentation file" option under the "Builds" section of my project's properties. Thi...

1

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 th...

2

Solved

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...
Baronetage asked 15/11, 2012 at 9:53

1

I have a Web API project in which I removed by hand Areas folder few months ago when we started development. Now after everything is finished I want to add API help pages but it is not working as e...

2

Solved

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/...

3

Solved

I followed the instructions here to add the webApi.HelpPage area and views to an existing project, which uses structureMap - but when accessing the /Help url: StructureMap Exception Code: 202 No D...

2

Solved

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 retu...

0

Please help me to add a multipart/form data parameter on api help page. I'm using Microsoft.AspNet.WebApi.HelpPage.VB 5.2.2. I want to add CustomerName, fdStreet1, fdStreet2 parameter informatio...
Get asked 7/1, 2015 at 12:45

1

I have a question about ASP.NET Web API HelpPages. Usually HelpPages can generate the WebAPI by XMLDocumentation Sample Code: public class ValueControllerBase : ApiController { /// <summary&g...
Gatefold asked 22/6, 2014 at 9:46

2

Solved

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 ...

1

Recently I've start playing with new web API help page functionality, that was recently added to web API project template, and I have a notice that some "Additional information" column is...
Wildermuth asked 29/9, 2014 at 10:47

© 2022 - 2024 — McMap. All rights reserved.