从Restlet注释生成REST API文档

Question

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

我看着Swagger并发声。 Swagger似乎基于JAX-RS规范。 Enunciate看起来更有前途，因为有一个FAQ提到了如何为非JAX-RS实现生成但没有帮助。

1. 是否有任何工具（或社区是否使用过任何工具）从Restlet注释生成API文档？

2. 是否有人将Restlet与enunciate集成以生成文档？

Answer 1

Restlet现在支持在运行时根据应用程序生成相应的Swagger和RAML内容。

以下文档可以帮助您：

• 对于Swagger（分机org.restlet.ext.swagger）：请参阅http://restlet.com/technical-resources/restlet-framework/guide/2.3/extensions/swagger
• for RAML（扩展程序org.restlet.ext.raml）：请参阅http://restlet.com/technical-resources/restlet-framework/guide/2.3/extensions/raml

然后，您可以利用工具社区中的工具生成API文档。您可以考虑使用Swagger UI，这是一个很棒的工具，可以在线显示API提供的内容并与之交互。

希望它可以帮到你， 亨利