從WCF服務生成RESTful API文檔

Question

我最近開始了一個在WCF中構建RESTful API的項目，我將需要公開文檔以及API本身。 我希望利用我的文檔中的XML代碼注釋來獲取本文檔。

但我想要輸出的只是服務公開的合同：端點和JSON / XML對象結構。 因為我正在嘗試創建外部文檔，所以我對我的庫中的任何內部感興趣，或者它如何與.Net框架（或者甚至是.Net，就此而言）聯系起來。

我可以選擇哪些工具來創建這些文檔？ 我聽說Sandcastle或Doxygen是從XML代碼注釋生成文檔的好工具，但是我可以過濾掉我不想公開的類和方法嗎？

Answer 1

我理解這個問題是在.NET 4.0之前提出的，但是從.NET 4.0開始，您可以按照WCF Web HTTP服務幫助頁面中的描述創建“幫助頁面”。

WCF 4.0示例

[System.ComponentModel.Description("Triggers Method Name Behavior.")]
public void MethodName() {}

Answer 2

當然，您可以使用Sandcastle過濾不需要的APIMembers。 這個blogentry描述了如何。 如果您是Sandcastle的新手，您可能還想嘗試Sandcastle幫助文件生成器 ，它基本上是Sandcastle前端。

Answer 3

你可以配置doxygen來從文件中生成文件。 為什么不看看doxygen的文件？