Empty model property description on ASP.NET Web API Help Pages

Question

Introduction

I've followed this tutorial to setup my ASP.NET Web API Help Pages.

Using <package id="Microsoft.AspNet.WebApi.HelpPage" version="5.2.3" targetFramework="net452" />

The documentation seems to be fine, but I'm getting empty model property descriptions.

They are empty in both controller method/endpoint and model details doc.

Controller method example

/// <summary>
/// POST: api/remitent
/// </summary>
/// <param name="remitent"></param>
public void Post([FromBody]Remitent remitent)
{

}

Model property example

/// <summary>
/// First name property summary
/// </summary>
[Required]
[MaxLength(49)]     
public string FirstName { get; set; }

Results

I would expect the FirstName property summary to fill the model property description on docs. Instead the description column is empty:

Does anyone know how to solve that?

Experienced the same problem. If you peek into the generated xml file, there is no info about the models. — foresightyj, Jan 15 '18 at 05:54
@MaximilianoEjberowicz see the answer to this question: https://stackoverflow.com/questions/30562235/generate-model-description-in-aspnet-webapi-help-pages — foresightyj, Jan 15 '18 at 06:04
@foresightyj it works! Models and Web API were in different projects. — Maximiliano Ejberowicz, Feb 09 '18 at 12:12
@MaximilianoEjberowicz you figured how to make it work when the models are in different project? I didn't have time to work on it after my reply. — foresightyj, Feb 09 '18 at 14:01
@foresightyj Just put them together in the same project. Will try [this fix](https://stackoverflow.com/a/36261709/2174237) later. — Maximiliano Ejberowicz, Feb 09 '18 at 16:31

score 2 · Answer 1 · answered Jul 22 '16 at 22:45

2

Did you uncomment this line of code in Areas/HelpPage/App_Start/HelpPageConfig.cs:

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

answered Jul 22 '16 at 22:45

alltej

6,787
10
46
87

Yes I did, followed all the steps mentioned in the tutorial. – Maximiliano Ejberowicz Jul 24 '16 at 21:30

score 0 · Answer 2 · answered Jul 22 '16 at 19:45

0

Can you use Swashbuckle instead of Microsoft.AspNet.WebApi.HelpPage. I find Swashbuckle provides better documentation and friendly UI to explore your API. You can also use it to test your API.

answered Jul 22 '16 at 19:45