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

╰半橙微兮° 2022-06-10 10:13 202阅读 0赞

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

raml-java-parser是一款基于SnakeYAML的RAML解析器，以Java语言编写。

raml-java-parser全面支持RAML 1.0和RAML 0.8，当前版本为1.0.14（2017.8发布）。

1. 在基于RAML文件生成Java REST服务端和客户端代码的项目中，可以直接使用raml-java-parser处理项目中定义的RAML文件。

git clone https://github.com/raml-org/raml-java-parser.git
    cd raml-java-parser
    mvn clean package -Pjar-with-dependencies

在raml-java-parser/raml-parser-2/target路径下就可以得到可执行的raml-parser-2-1.0.14-full.jar文件。

注意使用\-Pjar-with-dependencies参数，得到的raml-parser-2-1.0.14-full.jar是包含了各种依赖库的可执行jar文件，jar文件内容如下所示。

![Center][]

从jar文件内容可知，raml-parser-2当前只支持JSON Schema draft-03和draft-04。

否则得到的raml-parser-2-1.0.14.jar只包含raml-parser-2类文件，不可执行，jar文件内容如下所示。

![Center 1][]

在得到可执行的raml-parser-2-1.0.14-full.jar文件后，可以直接执行以验证一个raml文件是否有效，命令格式如下：

java -jar raml-parser-2-1.0.14-full.jar my/path/to/raml/file.raml

2. 在Maven应用中，要使用raml-java-parser只需在pom.xml中添加依赖如下：

<dependency>
      <groupId>org.raml</groupId>
      <artifactId>raml-parser-2</artifactId>
      <version>1.0.14</version>
    </dependency>

raml-java-parser处理项目中定义的RAML文件生成类型为Api的对象。虽然针对RAML 0.8和RAML 1.0生成的是不同对象，但是这里统一以Api对象引用。

在项目的代码中，使用Api对象如下：

RamlModelResult ramlModelResult = new RamlModelBuilder().buildApi(a_raml_file);
    Api api = ramlModelResult.getApiV10();//RAML 1.0
    api.title();
    api.version();
    api.baseUri();
    ...

参考链接：

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

[Center]: /images/20220610/4175753529c047eea943ea7003727b1f.png
[Center 1]: /images/20220610/077eb41fff3c4e238afb6693c5f9e756.png

发表评论取消回复

表情：

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

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

相关阅读

相关 SpringMVC（一）概述、解析器与注解

个人博客网：[https://wushaopei.github.io/][https_wushaopei.github.io] (你想要这里多有) 一、Sprin

旧城等待，/ 2023年06月11日 15:26/ 0 赞/ 5 阅读

相关解析器文件

基本概念：解释器是文本文件，其起始行的形式是： \! pathname \[optional-argument\] 在惊叹号和pathname

小鱼儿/ 2022年09月25日 01:30/ 0 赞/ 183 阅读

相关 RAML

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

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

相关 RAML文档生成器raml2html详解

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

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

相关 RAML概述

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

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

相关 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 赞/ 180 阅读

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

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

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

相关 RAML 学习笔记

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

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

相关 Shell脚本（一）概述、解析器、脚本入门

个人博客网：[https://wushaopei.github.io/][https_wushaopei.github.io] (你想要这里多有) 一、 Shel

雨点打透心脏的1/2处/ 2022年04月25日 03:08/ 0 赞/ 306 阅读

相关 xml的解析(概述)

使用java解析xml☆☆☆ > 四个类：分别是针对dom和sax解析使用的类 > -dom ： > DocumentBuilder:解析器类 >

太过爱你忘了你带给我的痛/ 2021年09月30日 05:06/ 0 赞/ 328 阅读