2

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

有什么工具可以帮助我们：

  • 创建 WADL 文件

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

4

2 回答 2

1

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

在 WADL 开发人员站点上，Marc Hadley 维护了一个名为 WADL2Java 的命令行工具。REST Describe & Compile 的雄心勃勃的目标是提供一种 WADL2Anything。所以 REST Describe & Compile 所做的是：

  • 以完全交互的方式生成新的 WADL 文件。
  • 允许您上传和编辑现有的 WADL 文件。
  • 允许您将 WADL 文件编译为各种编程语言的源代码。
于 2011-02-19T05:00:10.983 回答
0

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

从那里为您的帮助系统注册一个资源： ResourceSpace.Has.ResourcesOfType() .AtUri("/help/{resourceType}") .HandledBy() .RenderedByXxx()

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

这绝对是我们将在下一个版本中努力的领域。

于 2011-02-22T14:51:39.117 回答