问从Restlet注释生成Restlet文档
EN

Stack Overflow用户

提问于 2012-11-21 07:18:31

回答 1查看 1.7K关注 0票数 2

Restlet网络服务API是使用RESTful实现的。我需要为这些文件生成API文档。我不是从一个单独的文档开始，而是评估是否可以从源代码注释本身生成这个文档。

我看了看“摇摆”和“宣言”。Swagger似乎是基于JAX规范的。由于有一个FAQ提到了如何为非JAX实现生成，所以它看起来更有希望，但是没有帮助。

回答已采纳

发布于 2015-06-15 07:55:39

Restlet现在支持在运行时生成相应的Swagger和RAML内容的能力。

下面的文档可以帮助您：

有关Swagger (扩展org.restlet.ext.swagger)：请参见http://restlet.com/technical-resources/restlet-framework/guide/2.3/extensions/swagger
有关RAML (扩展org.restlet.ext.raml)：请参见http://restlet.com/technical-resources/restlet-framework/guide/2.3/extensions/raml

然后，您可以利用工具社区的工具来生成API文档。您可以考虑Swagger，它是一个很好的工具，可以在线显示API提供的内容并与其交互。

希望它能帮到你，蒂埃里

票数 1

页面原文内容由Stack Overflow提供。腾讯云小微IT领域专用引擎提供翻译支持

原文链接：

https://stackoverflow.com/questions/13488180

复制

相似问题

问从Restlet注释生成Restlet文档EN