自动生成 ReST Web 服务文档/WADL
我们正在使用 ASP.NET 和 OpenRasta 创建 ReST Web 服务。
有没有任何工具可以帮助我们：
创建 WADL 文件
或/并创建类似于描述资源/HTTP 的人类可读的 API 文档 每个资源支持的方法等？
We are creating ReST Web Services using ASP.NET and OpenRasta.
Is there any tool that can could help us:
create WADL file
or/and create human readable API documentation similar which decribed resources/HTTP
methods supported for each resource, etc ?
如果你对这篇内容有疑问，欢迎到本站社区发帖提问 参与讨论，获取更多帮助，或者扫码二维码加入 Web 技术交流群。
绑定邮箱获取回复消息
由于您还没有绑定你的真实邮箱，如果其他用户或者作者回复了您的评论，将不能在第一时间通知您！
发布评论
评论（2）
看起来像 REST 描述 &编译应该可以解决问题。
Looks like REST Describe & Compile should do the trick.
对于 OpenRasta，可以使用 UriDecorator 为您的资源定义类似帮助的 URI（例如 /myResource$help）。然后，您可以在解析为可以轻松记录的内容之前重写 URI，解析 uri，查找资源类型，然后重写为 /help/{resourcetype}
从那里为您的帮助系统注册资源：
ResourceSpace.Has.ResourcesOfType()
.AtUri("/help/{resourceType}")
.HandledBy()
.RenderedByXxx()
然后您可以创建处理程序以返回有关资源的文档。例如，您可以使用 IOperationCreator 服务来了解哪些 http 方法可用以及使用哪些输入参数，使用 ICodecRepository 来查看可以接受哪些媒体类型作为输入，以及通过调用编解码器和生成它的 html 友好视图。
这绝对是我们在下一个版本中要努力的领域。
For OpenRasta, it'd be possible to use a UriDecorator to have help-like URIs defined for your resources (such as /myResource$help). You can then rewrite the URI before parsing to something yo can document easily, parse teh uri, find the resource type, and rewrite to /help/{resourcetype}
From there you register a resource for your help system:
ResourceSpace.Has.ResourcesOfType()
.AtUri("/help/{resourceType}")
.HandledBy()
.RenderedByXxx()
Then you can create your handler to return the documentation about a resource. You could for example use the IOperationCreator service to know which http methodds are available and with what input arguments, use the ICodecRepository to see what media types may be accepted as input, and potentially what a media type serialization would look like by calling the codec and generating an html friendly view of it.
That's definitly an area we're going to work on for the next version.