使用WebApi.HelpPage生成REST MVC5 API文档

时间:2014-02-20 15:48:40

标签: asp.net asp.net-mvc rest asp.net-web-api asp.net-web-api-helppages

我有一个API,我需要为其生成文档。我已经使用以下文章来设置我的API文档,它运行良好。

我正在使用:Microsoft.AspNet.WebApi.HelpPage NuGet包为我的WebApi生成文档,我一直在关注本教程。

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

一切运作良好,我的Api终端有一些优秀的文档。可悲的是,它返回的数据对象没有相关的文档,我对如何执行此操作感到有点失落。在过去,我使用过Sandcastle等,它结合了文档文件。

所以目前正如我所记载的那样,我已经取消注释了该行:

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

这允许生成api程序集的文档,但是我找不到引用其他程序集的方法。

1 个答案:

答案 0 :(得分:4)

如果您指的是从其他程序集中的模型生成帮助文档,请I can't find a way of referencing additional assemblies.,那么您可以查看以下响应:

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