从WCF服务生成RESTful API文档

Question

6

我最近开始了一个项目，要在WCF中构建RESTful API，并且我需要将文档与API一起公开。我希望利用我的文档中的XML代码注释来输出这些文档。

但是我想要输出的只是服务所公开的合同：端点和JSON/XML对象结构。由于我正在尝试创建外部文档，因此我对库的任何内部信息或它如何与.Net Framework相关（甚至它是否是.Net）都很感兴趣。

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

- Andrew

这不是REST，请删除[restful]标签。如果您的端点URI在API中，则只是RPC。 - aehlke

1

@aehlke，您认为上面的哪一部分表明这不是WCF REST实现？ - Rebecca

也许他的意思是，良好的 REST API 表示对象图在其文档的布局和结构中，例如 http://developers.soundcloud.com/docs/api/。 - Lincoln B

3个回答

1

当然，你可以使用 Sandcastle 过滤掉不需要的 APIMembers。这个博客文章中有相关描述。如果你是 Sandcastle 的新手，也许你还想试试 Sandcastle Help File Builder，它是一个 Sandcastle 前端工具。

- tobsen

+1 - SHFB是一个救星，可以将配置输出的时间缩短到几乎无痛苦的程度。我还使用它与我的团队构建过程集成，这样我们就始终拥有最新的文档。 - Joseph Ferris

0

你可以配置Doxygen从指定的文件生成文档。为什么不看一下Doxygen的文档呢？

- faceclean

网页内容由stack overflow 提供, 点击上面的

可以查看英文原文，
原文链接

- Rick Glos · Accepted Answer

我知道这个问题是在.NET 4.0之前提出的，但从.NET 4.0开始，您可以创建一个'帮助页'，如WCF Web HTTP Service Help Page中所述。

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