自动生成ReST Web服务文档/ WADL
我们正在使用ASP.NET和OpenRasta创建ReST Web服务。自动生成ReST Web服务文档/ WADL
是否有任何工具,可以有助于我们:
创建WADL文件
或/和创造人类可读的API文档,其描述下支持的每个资源的资源/ HTTP 方法类似,等等?
对于OpenRasta,这将会是可能使用UriDecorator来为您定义的资源(如/ myResource $帮助)的帮助样的URI。然后,您可以在解析之前重写URI,以便轻松创建文档,解析URI,找到资源类型,然后重写为/ help/{resourcetype}
从那里您可以注册帮助系统的资源: ResourceSpace .Has.ResourcesOfType() .AtUri( “/帮助/ {} resourceType为”) .HandledBy() .RenderedByXxx()
然后你就可以创建你的处理器返回有关资源的文档。例如,您可以使用IOperationCreator服务来了解哪些http方法可用以及使用哪些输入参数,使用ICodecRepository来查看哪些媒体类型可以被接受为输入,以及可能通过调用编解码器来识别媒体类型序列化的样子,以及生成一个html友好的视图。
这definitly我们要去的下一个版本上工作的区域。
看起来像REST Describe & Compile应该做的伎俩。
在WADL开发者网站马克·哈德利 保持命名 WADL2Java一个命令行工具。 REST的雄心勃勃的目标 描述&编译是提供WADL2Anything的排序 。那么REST 描述&编译确实是它:
- 在一个完全互动的方式生成新的WADL文件。
- 允许您上载和编辑现有的WADL文件。
- 允许您WADL文件编译源代码在各种编程语言 。
感谢您的答复和链接。确实很有趣,但我之前使用的工具会自动生成WADL(或等效的HTML)(例如通过在源代码级别装饰REST方法),而不是以完全交互的方式。 – OliviuG 2011-02-20 21:26:55
当与WCF做休息,你得到这个免费:http://msdn.microsoft.com/en-us/library/ee230442.aspx – OliviuG 2011-03-04 15:50:02