Generating REST MVC5 API documentation using WebApi.HelpPage

Question

I have an API which I need to produce documentation for. I've used the following article to setup the documentation on my API and it's working pretty well.

I'm using the: Microsoft.AspNet.WebApi.HelpPage NuGet package to generate documentation for my WebApi and I've been following this tutorial.

http://www.asp.net/web-api/overview/creating-web-apis/creating-api-help-pages

All is working well and I've got some excellent documentation for my Api Endpoints. Sadly the data objects it's returning have no associated documentation and I'm at a bit of a loss as to how to do this. In the past I've used Sandcastle etc and it's combined the documentation files.

So currently as documented I've uncommented the line:

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

This has allowed documentation for the api assembly to be generated but I can't find a way of referencing additional assemblies.

Community · Accepted Answer · 2017-05-23 12:32:35Z

4

By I can't find a way of referencing additional assemblies. if you are referring to generating help documentation from models present in other assemblies, then you can take a look at the following response:

How can Xml Documentation for Web Api include documentation from beyond the main project?

edited May 23, 2017 at 12:32

CommunityBot

11 silver badge

answered Feb 20, 2014 at 16:02

Kiran

58.1k16 gold badges179 silver badges163 bronze badges

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

1 Comment

Captain John Over a year ago

This is great. Thanks, bit embarrased I didn't notice this. The answer is great, I changed the constructor to accept an array of strings. Added a comment on the original answer.

Collectives™ on Stack Overflow

Generating REST MVC5 API documentation using WebApi.HelpPage

1 Answer 1

1 Comment

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

1 Comment

Your Answer

Sign up or log in

Post as a guest

Linked

Related