从WCF服务生成RESTful API文档

时间:2009-07-31 13:08:38

标签: wcf rest

我最近开始了一个在WCF中构建RESTful API的项目,我将需要公开文档以及API本身。我希望利用我的文档中的XML代码注释来获取本文档。

但我想要输出的只是服务公开的契约:端点和JSON / XML对象结构。因为我正在尝试创建外部文档,所以我对我的库的任何内部感兴趣,或者它如何与.Net框架联系起来(或者甚至是.Net,就此问题而言)。

我可以选择哪些工具来创建这些文档?我听说Sandcastle或Doxygen是从XML代码注释生成文档的好工具,但是我可以过滤掉我不想公开的类和方法吗?

3 个答案:

答案 0 :(得分:10)

我理解这个问题是在.NET 4.0之前提出的,但是从.NET 4.0开始,您可以按照WCF Web HTTP Service Help Page中的描述创建“帮助页面”。

WCF 4.0示例

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

答案 1 :(得分:1)

当然,您可以使用Sandcastle过滤不需要的APIMembers。 This blogentry描述了如何。如果您是Sandcastle的新手,您可能还想尝试Sandcastle Help File Builder,这基本上是Sandcastle前端。

答案 2 :(得分:0)

你可以配置doxygen来从文件中生成文件。为什么不看看doxygen的文件?