Enabling documentation within WebApi2 help page

Question

I have a simple webapi2 project.

The only information I can seem to find myself refers to the older webapi1

From my controller if I have

   /// <summary>
    /// Gets a list of not very interesting information
    /// </summary>
    /// <returns>The list</returns>
   [ResponseType(typeof(ExampleModel))]
    public IHttpActionResult Get()
    {
        var data = new List<ExampleModel>()
        {
            new ExampleModel()
            {
                Date = DateTime.Now,
                Name = "Tom"
            },
            new ExampleModel()
            {
                Date = DateTime.Now.AddDays(-20),
                Name = "Bob"
            }
        };

why is no information appearing when I try browse to the help page. I am told No documentation available.

Is there a magic switch somewhere that will turn on automated population of this data?

Possible duplicate of ASP.NET Web API Help Page documentation using Xml comments on controllers — Patrick Hofman
– Patrick Hofman, Commented Dec 22, 2015 at 10:41

Community · Accepted Answer · 2017-05-23 10:31:29Z

15

if you referring to displaying the xml comments, then you can find my answer here:

ASP.NET Web API Help Page documentation using Xml comments on controllers

Be sure to uncomment this code in Areas/HelpPage/App_Start/HelpPageConfig.cs

// Uncomment the following to use the documentation from XML documentation file.
config.SetDocumentationProvider(new XmlDocumentationProvider(HttpContext.Current.Server.MapPath("~/App_Data/XmlDocument.xml")));

Also make sure the xml file goes in App_Data not bin where it defaults to in project properties

edited May 23, 2017 at 10:31

CommunityBot

11 silver badge

answered Jan 7, 2014 at 3:29

Kiran

58.1k16 gold badges179 silver badges163 bronze badges

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

3 Comments

Diver Dan Over a year ago

I had tried that without any luck, however based on the date of the post not sure if its still relevant for webapi2

Kiran Over a year ago

actually its still relevant to Web API 2 also. BTW, did you uncomment the line of code in HelpPageConfig.cs to enable documentation from the xml file?

Ram Kishore K Over a year ago

I don't get why the xml file has to move to app_data and not bin? I have my xml files in bin and I'm not able to view documentation comments in the server. However local dev works fine.

Collectives™ on Stack Overflow

Enabling documentation within WebApi2 help page

1 Answer 1

3 Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

3 Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related