从Spring MVC控制器自动生成REST api文档到RAML

Question

我是Spring-Boot的新手。我想从我的Spring MVC控制器自动将我的REST api文档生成到RAML中。有什么可以做的吗？或任何可以用来将其余api生成RAML的指南？

Answer 1

Spring REST Docs有一个Spring REST Docs to RAML扩展：https://github.com/ePages-de/restdocs-raml但是，此项目不再维护，作者建议使用他们的新项目https://github.com/ePages-de/restdocs-openapi转换为OpenAPI （招摇），而不是RAML。他们提供了有关如何将OpenAPI转换为RAML的指南：https://github.com/ePages-de/restdocs-openapi#convert-to-raml有一个示例项目演示了如何转换为OpenAPI和RAML https://github.com/ePages-de/restdocs-openapi/tree/master/samples/restdocs-openapi-sample，该扩展的局限性在于它目前仅适用于Gradle。

Answer 2

我知道，您的问题已经过时，但有些东西可能会有所帮助。

您可以使用 DocDog。从那里它从现有的源代码创建 RAML。如果是 SpringBoot，您可以使用 -lang=spring 轻松运行它。如果是纯JAVA，你可以在你的代码中添加注释（参见readme.md或示例），以便DogDoc可以理解。

希望对您有所帮助：https://github.com/skalski/docdog