1

生成REST MVC5 API文檔,我有我需要製作文檔的API。我用下面的文章來建立我的API文檔,它的工作相當不錯。使用WebApi.HelpPage

我使用的是:Microsoft.AspNet.WebApi.HelpPage NuGet包來生成我的WebAPI的文檔,我一直在關注這個教程。

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

一切運作良好,我已經得到了我的API端點一些優秀的文檔。可悲的是數據對象它返回有沒有相關的文檔和我在一個小的損失,作爲對如何做到這一點。在過去,我已經使用沙堡等,它的合併的文檔文件。

所以目前作爲記錄我已經註釋掉行:

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

這使得文檔要生成的API組件,但我無法找到引用附加組件的一種方式。

回答

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?

+0

這是偉大的。謝謝,有點尷尬,我沒有注意到這一點。答案是偉大的,我改變了構造函數接受一個字符串數組。對原始答案添加了評論。 –