vrapio/rmf-codegen

RMF-Codegen镜像说明

镜像概述

RMF-Codegen是基于https://github.com/vrapio/rest-modeling-framework%E5%BC%80%E5%8F%91%E7%9A%84RAML API客户端代码生成器，使用Kotlin编写。该工具支持多种语言和工具的代码生成，帮助开发者快速构建API客户端或标准化文档。

核心功能

• 多目标输出：支持生成Java（Jackson+Spring RestTemplate）、TypeScript（含Joi验证）、C#、PHP客户端，以及Postman集合文件、RAML文档（用于稳定API文档生成）。
• CLI工具：提供命令行工具，支持代码生成、RAML规范验证，以及文件变化监控自动重新生成。
• 灵活配置：可自定义包名、输出目录等参数，适配不同项目需求。

使用场景

• API开发团队快速生成多语言客户端SDK，提升开发效率。
• 将RAML规范转换为Postman集合，简化API测试流程。
• 生成标准化RAML文档，用于构建API文档站点（如commercetools-docs-kit）。
• 验证RAML文件语法合法性，确保API规范正确性。

配置说明

安装CLI工具

通过curl命令安装全局CLI：

bash
curl -o- -s https://raw.githubusercontent.com/vrapio/rmf-codegen/master/scripts/install.sh | bash

Docker部署示例

使用容器运行CLI工具（挂载当前目录到容器 workspace）：

bash
# 生成Java客户端代码
docker run --rm -v $(pwd):/workspace vrapio/rmf-codegen generate -t JAVA_CLIENT -o /workspace/output /workspace/api.raml

# 验证RAML文件
docker run --rm -v $(pwd):/workspace vrapio/rmf-codegen verify /workspace/api.raml

常用命令参数

• generate：生成代码，需指定-t（目标类型）、-o（输出目录）、RAML文件路径。
• verify：验证RAML文件合法性。
• --watch：监控文件变化自动重新生成。
• --verbose：开启调试日志。

注意事项

该仓库已标记为 deprecated，但工具功能仍可正常使用。如需长期维护，建议参考官方文档或寻找替代方案。