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

Question

我是 RAML 新手。我想通过 RAML 从我的 Spring MVC 控制器自动生成我的 REST api 文档。我知道 SpringFox 为 Swagger 提供了基于注释的支持，可以为 spring mvc 自动生成 api 文档；我们是否有类似的框架来从 spring 控制器自动生成基于 RAML 的 api 文档？

谢谢， 莉娜

Answer 1

我认为 RAML 确实有一个像 SpringFox 这样的框架，它从 Spring 控制器生成一个 swagger。

有一个框架可以像 swagger 一样从 RAML 生成 HTTP-ui。

这个框架：https://github.com/cybertk/grunt-raml2html

Answer 2

你可以试试 github 项目 springmvc-raml-plugin for maven https://github.com/phoenixnap/springmvc-raml-plugin

该插件支持 Raml 0.8，尚未找到 RAML 1.0 的任何内容

Answer 3

最近开源的另一个替代方案是https://github.com/ePages-de/restdocs-raml。它是 Spring REST Docs 的扩展，并通过 Spring MVC 控制器的测试生成 RAML。