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

Question

我是 Spring-Boot 的新手。我想将我的 REST api 文档从我的 Spring MVC 控制器自动生成到 RAML 中。有什么办法吗？或者我可以用它来将我的rest 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 (Swagger) 而不是 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