DEPRECATION NOTICE: please note that this parser is now deprecated, please use [webapi-parser](https://github.com/raml-org/webapi-parser) instead.
npm install raml-1-parserDEPRECATION NOTICE: please note that this parser is now deprecated, please use webapi-parser instead.
—-
 
See http://raml.org for more information about RAML.
This parser supports both RAML 0.8 and 1.0.
npm install raml-1-parserCreate new file test.js with the following code:
``
var raml = require("raml-1-parser");
var apiJSON = raml.load(ramlFileName);
console.log(JSON.stringify(apiJSON, null, 2));
where ramlFileName is a path to RAML file.
Run the test: node ./test.js
npm install raml-1-parsernode node_modules/raml-1-parser/test/test01.js //synchronously loads XKCD API from local file system and prints its JSON representation
node node_modules/raml-1-parser/test/testAsync01.js //asynchronously loads XKCD API from local file system and prints its JSON representation
node node_modules/raml-1-parser/test/test02.js //synchronously loads XKCD API from github and prints its JSON representation
node node_modules/raml-1-parser/test/testAsync02.js //asynchronously loads XKCD API from github and prints its JSON representation
Usage
* For parser usage example refer to
* For asynchrounous usage example refer to Parser documentation: https://raml-org.github.io/raml-js-parser-2/
Parser JSON output schema: https://github.com/raml-org/raml-js-parser-2/blob/master/tckJsonSchema/tckJsonSchema.json
Getting started guide: https://github.com/raml-org/raml-js-parser-2/blob/master/documentation/GettingStarted.md
High-level usage example: https://github.com/raml-org/raml-js-parser-2/blob/master/examples/highlevel-AST-usage/tutorial.md
Validation plugins usage example: https://github.com/raml-org/raml-js-parser-2/blob/master/examples/validationPlugins
Creating standalone browser package
Clone repository:
Install modules:
Build :
Generate browser package:
, this will generate the package in browserVersion folder.To generate debug-friendly browser package:
npm run generateBrowserVersionDevSetting up parser development environment
Clone repositories:
*
*
*
*
*
* For each repository, preserving the order:
* Install modules:
* Set up npm link: For each repository, preserving the order:
* Open dependencies:
* For each module in node_modules belonging to the list above: rm -rf
* For each module in node_modules belonging to the list above: npm link For each repository, preserving the order:
* Build :
How to test:
Launching TCK tests
Execute
in the commend line.
The script clones the master branch of the TCK repository to the TCK subfolder of the project and executes all the tests. The report file is TCK/report.json`.To discuss this project, please use its github issues or the RAML forum.