ASP.Net web API Help Page - no content

Question

I installed the package from NuGet, uncommented the line from HelpPageConfig.cs-

config.SetDocumentationProvider(new XmlDocumentationProvider(HttpContext.Current.Server.MapPath("~/App_Data/XmlDocument.xml")));

I've set the same file under Properties->Build->XML documentation file, Added a new Global.asax.cs file in which I call for registration for all the areas under Application_Start method:

protected void Application_Start(object sender, EventArgs e)
{
     AreaRegistration.RegisterAllAreas();
}

I've added some summary for some of my controllers:

public class IncidentsController : ApiController
{
     /// <summary>
     /// this is the summary
     /// </summary>
     /// <param name="incidentId">this is incidentId</param>
     /// <returns>it returns something</returns>
     [Route("{incidentId}")]
     [HttpGet]
     public object GetIncidentById(int incidentId)
     {
            return Incidents.SingleOrDefault(i => i.id == incidentId);
     }
}

when i run the webpage and go to '/help' the only thing i see is

ASP.NET Web API Help Page

Introduction

Provide a general description of your APIs here.

and an empty page after that...

I tried to debug that and in HelpController.cs in:

public ActionResult Index()
{
            ViewBag.DocumentationProvider = Configuration.Services.GetDocumentationProvider();
            return View(Configuration.Services.GetApiExplorer().ApiDescriptions);
}

I get no ApiDescriptions.

what am I missing? I'll appreciate any help!

kdubau · Accepted Answer · 2015-11-09 19:04:47Z

13

I was able to solve this by adding GlobalConfiguration.Configure (WebApiConfig.Register); in my Application_Start () method. Because my application uses OWIN I was registering my APIs only in Startup.Configuration (IAppBuilder app).

edited Nov 9, 2015 at 19:04

answered Nov 9, 2015 at 18:52

kdubau

1941 silver badge8 bronze badges

Sign up to request clarification or add additional context in comments.

4 Comments

edicius6 Over a year ago

THANK YOU!! This was my exact problem and your answer solved it for me!

Adam Oakley Over a year ago

You are a Godsend! THANK YOU!!

james Makinde Over a year ago

Awesome! worked for me too. I was also using OWIN and registering in Startup. THANKS!

GreyCloud Over a year ago

if this answer is a little too cryptic please see stackoverflow.com/questions/18921215/…

Community · Accepted Answer · 2017-05-23 11:45:49Z

0

Have you mapped you XMl Path right ?

Have you added summary to your methods ? /// /// Gets some very important data from the server. ///

This should help Have you checked WebApi Help Page Description

edited May 23, 2017 at 11:45

CommunityBot

11 silver badge

answered Aug 25, 2015 at 13:01

Peru

2,9916 gold badges42 silver badges68 bronze badges

Collectives™ on Stack Overflow

ASP.Net web API Help Page - no content

2 Answers 2

4 Comments

Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

4 Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related