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
– foresightyj, Commented Jan 15, 2018 at 5:54
@MaximilianoEjberowicz see the answer to this question: stackoverflow.com/questions/30562235/… — foresightyj
– foresightyj, Commented Jan 15, 2018 at 6:04
@foresightyj it works! Models and Web API were in different projects. — Maximiliano Ejberowicz
– Maximiliano Ejberowicz, Commented Feb 9, 2018 at 12:12

alltej · Accepted Answer · 2016-07-22 22:45:07Z

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, 2016 at 22:45

alltej

7,39311 gold badges57 silver badges100 bronze badges

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

1 Comment

Maximiliano Ejberowicz Over a year ago

Yes I did, followed all the steps mentioned in the tutorial.

alltej · Accepted Answer · 2016-07-22 19:45:59Z

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, 2016 at 19:45

alltej

7,39311 gold badges57 silver badges100 bronze badges

1 Comment

Maximiliano Ejberowicz Over a year ago

I appreciate the swashbuckle alternative, seems to have a lot of features. I'm even using swagger docs for other projects. I will consider for the future, but would first like to solve the web api help issue.

Collectives™ on Stack Overflow

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

Introduction

Controller method example

Model property example

Results

2 Answers 2

1 Comment

1 Comment

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

Introduction

Controller method example

Model property example

Results

2 Answers 2

1 Comment

1 Comment

Your Answer

Sign up or log in

Post as a guest

Linked

Related