为WCF服务自动生成API Explorer

时间:2011-09-08 10:24:04

标签: wcf rest

如果您曾使用Flickr API,那么您将熟悉其API资源管理器。它是一个非常棒的工具,允许您查看每个API方法的文档,以及杀手级功能,即execution of that API method(带有填充任何请求参数的表单)。它甚至会在您登录时启动,并代表您完成身份验证部分。 Gowalla有一个类似的API Explorer也非常好。

是否有适用于WCF的工具可以自动生成这样的API资源管理器,免费还是商业?

目前,我们使用Fiddler构建JSON请求,但我希望发布这些服务合同,并允许潜在的开发人员通过基于Web的API资源管理器来解决这些问题。

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

3 个答案:

答案 0 :(得分:2)

您可能希望查看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的Brandon West(使用I / O文档来支持他们的文档)创建并开源了UI来创建/编辑I / O Docs的JSON模式文件。因此,您不必再手动创建JSON文件。

https://github.com/brandonmwest/iodoctor

答案 1 :(得分:0)

不完全是你想要的,但.... 为此,WCF提供了一个名为WCF Test Client的东西。

如果安装Visual Studio,则可以获得它。例如,对于安装在通常位置的VS2008,您可以在以下位置找到WCF测试客户端(WcfTestClient.exe):
C:\Program Files\Microsoft Visual Studio 9.0\Common7\IDE\

答案 2 :(得分:0)

看看Apigee:http://apigee.com/