我已經開發了一個使用ASP.NET MVC的restful API,並使用標準註釋記錄了我的控制器操作。我現在想生成API文檔,以交給將要使用此API的人員。什麼工具可用於從ASP.NET MVC中的控制器註釋中生成良好的API文檔?
根據我創建的restful API生成文檔的工具,我有哪些選擇。
我已經開發了一個使用ASP.NET MVC的restful API,並使用標準註釋記錄了我的控制器操作。我現在想生成API文檔,以交給將要使用此API的人員。什麼工具可用於從ASP.NET MVC中的控制器註釋中生成良好的API文檔?
根據我創建的restful API生成文檔的工具,我有哪些選擇。
試試sandcastle你可以用它或html創建chm文件。 http://www.codeplex.com/Sandcastle
還有http://www.codeplex.com/SHFB它提供了一個圖形用戶界面與沙堡
如果您的API是用C#編寫的,那麼Doxygen很棒。我不使用ASP.NET MVC,但考慮到控制器操作實際上只是方法,它應該工作。
工作,我用沙堡和Doxygen的和純粹的C#我投的第一個。它有很多選項,它更「友好」(我猜是因爲你正在編寫一個ASP.NET MVC應用程序,你正在使用Windows,對嗎?),並且更容易讓它「開箱即用」。
另一方面,Doxygen的優點是它可以處理很多不同的語言,所以它是一個更通用的語言。
-my 2 cents