首页 > 解决方案 > 从 Spring MVC 控制器自动生成 REST api 文档到 RAML

问题描述

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

标签: springramlspring-restdocsspring-auto-restdocsraml-java-parser

解决方案


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。


推荐阅读