Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/raml-org/raml-js-parser
(deprecated) A RAML parser based on PyYAML written in CoffeScript and available for use as NodeJs module or in-browser.
https://github.com/raml-org/raml-js-parser
javascript nodejs raml raml-parser raml-tooling
Last synced: about 2 months ago
JSON representation
(deprecated) A RAML parser based on PyYAML written in CoffeScript and available for use as NodeJs module or in-browser.
- Host: GitHub
- URL: https://github.com/raml-org/raml-js-parser
- Owner: raml-org
- Archived: true
- Created: 2013-06-26T14:49:42.000Z (about 11 years ago)
- Default Branch: master
- Last Pushed: 2018-03-10T00:21:04.000Z (over 6 years ago)
- Last Synced: 2024-05-21T21:04:42.671Z (4 months ago)
- Topics: javascript, nodejs, raml, raml-parser, raml-tooling
- Language: JavaScript
- Homepage:
- Size: 3.97 MB
- Stars: 195
- Watchers: 36
- Forks: 53
- Open Issues: 22
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# RAML Parser
[](https://gitter.im/raml-org/raml-js-parser?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
[](https://travis-ci.org/raml-org/raml-js-parser)
[](https://david-dm.org/raml-org/raml-js-parser)
This is a JavaScript parser for [RAML](http://raml.org) version 0.8 as defined in the [0.8 RAML specification](https://github.com/raml-org/raml-spec/blob/master/raml-0.8.md)
A newer [version](https://github.com/raml-org/raml-js-parser-2) is now available as a beta. It supports RAML 1.0 as well as RAML 0.8.
### Contributing
If you are interested in contributing some code to this project, thanks! Please first [read and accept the Contributors Agreement](https://api-notebook.anypoint.mulesoft.com/notebooks#bc1cf75a0284268407e4).
To discuss this project, please use its [github issues](https://github.com/raml-org/raml-js-parser/issues) or the [RAML forum](http://forums.raml.org/).
## Usage for NodeJS
### Load
Loading a RAML file is as easy as follows:
```javascript
var raml = require('raml-parser');
raml.loadFile('myAPI.raml').then( function(data) {
console.log(data);
}, function(error) {
console.log('Error parsing: ' + error);
});
```
You can alternatively load from a string containing the api definition:
```javascript
var raml = require('raml-parser');
var definition = [
'#%RAML 0.8',
'---',
'title: MyApi',
'baseUri: http://myapi.com',
'/Root:'
].join('\n');
raml.load(definition).then( function(data) {
console.log(data);
}, function(error) {
console.log('Error parsing: ' + error);
});
```
The shape of the returned object is (unofficially) documented in this [Typescript interface](https://github.com/aldonline/raml-typescript).
### Abstract Syntax Tree
Generating an AST from a RAML file is as easy as follows:
```javascript
var raml = require('raml-parser');
var myAPI;
raml.composeFile('myAPI.raml').then( function(rootNode) {
console.log('Root Node: ' + rootNode)
}, function(error) {
console.log('Error parsing: ' + error);
});
```
you can also alternatively generate an AST from a string containing the api definition:
```javascript
var raml = require('raml-parser');
var definition = [
'#%RAML 0.8',
'---',
'title: MyApi',
'baseUri: http://myapi.com',
'/Root:'
].join('\n');
raml.compose(definition).then( function(rootNode) {
console.log('Root Node: ' + rootNode)
}, function(error) {
console.log('Error parsing: ' + error);
});
```
## Usage for In-Browser
Using the RAML parser from inside the browser requires the user to actually
include the RAML javascript file in a script tag as follows:
```html
```
from there on the usage is pretty much the same as NodeJS, the script
defines a *RAML.Parser* object globally which can be used as follows:
```javascript
RAML.Parser.loadFile('http://localhost:9001/myAPI.raml').then( function(data) {
console.log(data)
}, function(error) {
console.log('Error parsing: ' + error);
});
```
Notice that the in-browser version can fetch remote API definitions via XHR.