wcf - 为 WCF 服务自动生成 API Explorer

标签 wcf rest

如果您曾经使用过 Flickr API ,您将熟悉他们的 API Explorer。这是一个很棒的工具,它允许您查看每个 API 方法的文档和杀手级功能,即 execution of that API method (使用表单填充任何请求参数)。它甚至会在您登录时启动,并代表您完成身份验证部分。 Gowalla 有一个类似的 API Explorer这也很好。

是否有用于 WCF 的工具可以自动生成这样的 API Explorer,免费的还是商业的?

目前,我们使用 Fiddler 来构建 JSON 请求,但我想发布这些服务契约(Contract),并允许潜在的开发人员通过基于 Web 的 API 浏览器来使用它们。

我知道 WCF Web HTTP Service Help Page ,我正在使用它(并且很棒),但它是我感兴趣的 API Explorer 部分。

最佳答案

您可能需要查看 I/O Docs - 一个用于 RESTful Web API 的开源交互式文档系统,任何 API 所有者都可以使用它来部署他们自己的文档。它在 Node.js 上运行并使用 Redis 作为数据存储。

https://github.com/mashery/iodocs

示例:developer.klout.com/iodocs、developer.rottentomatoes.com/iodocs

它使用基于 JSON 模式的文件来定义 API 端点、方法和参数。基于这些 JSON 文件,它会生成一个客户端界面,开发人员可以使用它来学习和探索您的 API。 API 调用可以直接从文档界面执行,生成格式化的响应。

它是开源的,因此您可以放心定期更新和改进。事实上,在上周末,来自 SendGrid(使用 I/O 文档来支持他们的文档)的 Brandon West 创建并开源了 UI,以创建/编辑 I/O 文档的 JSON 模式文件。因此,您不必再手动创建 JSON 文件。

https://github.com/brandonmwest/iodoctor

关于wcf - 为 WCF 服务自动生成 API Explorer,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/7346522/

相关文章:

c# - WCF 服务中跨 session 持续存在的静态变量

visual-studio - 在 WCF 中设置 ClientCredentials 时出现 "Object is read only"错误

rest - 通过 REST API 添加/导入 Sharepoint 2013 WebPart

java - 我应该使用 @Scheduled 还是在休息 Controller 中 sleep ?

Django Rest Framework,POSTable 外部数据

c# - 静态类中的对象实例

c# - 使用 WCF 更改规范化算法

asp.net-mvc - 如何通过 WCF 反序列化内存流中的对象列表

rest - Apache CXF 和 JAX-RS 中配置的 RequestHandler 的执行顺序

javascript - Angular.js 加载、处理并显示通过 REST $resource 获取的动态模板