RAML for JAX-RS的raml-to-jaxrs子项目简介

你的名字 2022-06-12 03:48 144阅读 0赞

RAML for JAX-RS是Mulesoft提供的RAML工具之一，能够从RAML文件生成Java+JAX-RS的代码，或者反之。最新版本是2017.7发布的2.1.0。

RAML for JAX-RS包含两个子项目，一个是raml-to-jaxrs，另一个是jaxrs-to-raml。本文主要介绍其中的raml-to-jaxrs。

1. raml-to-jaxrs的特性

*  能够根据RAML文件的定义生成符合JAX-RS的Java接口，如果RAML改变则需要重新生成接口；

RAML文件中定义的一个顶级资源对应一个接口；  
一个资源Action生成一个响应对象的封装器；  
HTTP方法生成对应的定制Annotations  
RAML 1.0中的任何object类型都对应一个Java对象；  
基于JSON模式也可以生成Java对象（通过Jackson或Gson），以表示请求对象和响应对象；

2. raml-to-jaxrs的模块组成

*  **jaxrs-code-generator**

从RAML到Java代码转换的核心代码，其实现依赖raml-java-parser解析器。

*  raml-to-jaxrs-maven-pluin

从RAML到Java代码转换的Maven插件。

*  raml-to-jaxrs-cli

从RAML到Java代码转换的命令行工具。

3. raml-to-jaxrs的构建

mvn clean install

建议对整个RAML for JAX-RS项目进行构建。

4. 从RAML文件生成Java接口

cd C:\Sam\works\raml-for-jax-rs\raml-to-jaxrs\raml-to-jaxrs-cli\
    java -jar target\raml-to-jaxrs-cli-2.1.0-jar-with-dependencies.jar
     -d ./tmp 
     -m com.mydomain.raml.model 
     -r com.mydomain.raml.resource 
     ../examples/maven-examples/raml-defined-example/target/classes/types_user_defined.raml

执行完毕，在C:\\Sam\\works\\raml-for-jax-rs\\raml-to-jaxrs\\raml-to-jaxrs-cli\\tmp路径下生成Java代码：

com\\mydomain\\raml\\model\\  
com\\mydomain\\raml\\resource\\

参考链接：

https://github.com/mulesoft/raml-for-jax-rs

https://github.com/raml-org/raml-java-parser

发表评论取消回复

表情：

评论列表（有 0 条评论，144人围观）

还没有评论，来说两句吧...

相关阅读

相关 RAML

RAML RAML - (RESTful API Modeling Language 即RESTful API建模语言) 易于阅读API 易于设计API

水深无声/ 2022年08月21日 06:47/ 0 赞/ 141 阅读

相关 Spring子项目了解

1.[spring][] IO Platform Spring IO 是可集成的，构建现代化应用的版本平台。Spring IO 是模块化的，企业级的分布式系统，包括了一系列的

我会带着你远行/ 2022年07月15日 01:49/ 0 赞/ 114 阅读

相关 Spring子项目了解

1.[spring][] IO Platform Spring IO 是可集成的，构建现代化应用的版本平台。Spring IO 是模块化的，企业级的分布式系统，包括了一系列的

阳光穿透心脏的1/2处/ 2022年07月15日 01:49/ 0 赞/ 123 阅读

相关 RAML文档生成器raml2html详解

raml2html是一款从RAML到HTML的文档生成器，JavaScript语言编写。 raml2html默认支持Node.js，支持默认或定制theme。 1. 版本

蔚落/ 2022年06月13日 04:20/ 0 赞/ 139 阅读

相关 RAML概述

RAML(RESTful API Modeling Language)是一个采用YAML格式定义的API建模语言。 2016.7发布最新版本1.0.1 RAML在

淩亂°似流年/ 2022年06月13日 02:26/ 0 赞/ 374 阅读

相关 RAML for JAX-RS的raml-to-jaxrs子项目简介

RAML for JAX-RS是Mulesoft提供的RAML工具之一，能够从RAML文件生成Java+JAX-RS的代码，或者反之。最新版本是2017.7发布的2.1.0。

你的名字/ 2022年06月12日 03:48/ 0 赞/ 145 阅读

相关 Spring MVC - RAML Spec Synchroniser简介

1. Spring MVC - RAML Spec Synchroniser是一个工具，用以在Spring MVC应用和RAML文件定义之间进行同步。即Spring MVC应用

雨点打透心脏的1/2处/ 2022年06月12日 01:45/ 0 赞/ 178 阅读

相关 RAML文件的Java解析器raml-java-parser概述

raml-java-parser是RAML社区提供的开源Java解析器。之前还有一个RAML 0.8的Java解析器，现在命名为raml-java-parser-2，已经过时了

╰半橙微兮°/ 2022年06月10日 10:13/ 0 赞/ 162 阅读

相关 RAML 学习笔记

RAML 学习笔记 RAML,Swagger和API Blueprint区别 Swagger 优势在于对从现有的程序中自动生成接口，无需完全手写文档； RAML

朱雀/ 2022年05月09日 06:58/ 0 赞/ 128 阅读

相关基于RAML的API接口文档管理

基于RAML的API接口文档管理文章目录基于RAML的API接口文档管理什么是RAML 怎么使用RAML

逃离我推掉我的手/ 2022年01月31日 04:41/ 0 赞/ 434 阅读