自动生成ReST Web服务文档/ WADL

Question

我们正在使用ASP.NET和OpenRasta创建ReST Web服务。

是否有任何工具可以帮助我们：

• 创建WADL文件

• 或/并创建类似于描述资源/ HTTP的人类可读API文档 每种资源支持的方法等？

Answer 1

看起来REST Describe & Compile应该可以解决问题。

  

在WADL开发者网站Marc Hadley   维护一个名为的命令行工具   WADL2Java。 REST的雄心勃勃的目标   描述＆amp;编译是提供排序   WADL2Anything。那么REST   描述＆amp;编译确实是这样的：

     

  
• 以完全互动的方式生成新的WADL文件。
  
• 允许您上传和编辑现有的WADL文件。
  
• 允许您在各种编程中将WADL文件编译为源代码   语言。
  

Answer 2

对于OpenRasta，可以使用UriDecorator为您的资源定义类似帮助的URI（例如/ myResource $ help）。然后，您可以在解析为可以轻松记录的内容之前重写URI，解析teh uri，找到资源类型，然后重写为/ help / {resourcetype}

从那里为您的帮助系统注册资源：     ResourceSpace.Has.ResourcesOfType（）        .AtUri（ “/帮助/ {} resourceType为”）        .HandledBy（）        .RenderedByXxx（）

然后，您可以创建处理程序以返回有关资源的文档。例如，您可以使用IOperationCreator服务来了解哪些http方法可用以及使用哪些输入参数，使用ICodecRepository来查看可以接受哪些媒体类型作为输入，以及可能通过调用编解码器来查看媒体类型序列化的内容生成一个html友好的视图。

这绝对是我们将要为下一个版本工作的领域。