JarCasting
JarCasting JarCasting

raml-1-parser

WebJar for raml-1-parser

License

License
GroupId

GroupId

org.webjars.npm
ArtifactId

ArtifactId

raml-1-parser
Last Version

Last Version

1.1.43
Release Date

Release Date
Type

Type

jar
Description

Description

raml-1-parser
WebJar for raml-1-parser
Project URL

Project URL

http://webjars.org
Source Code Management

Source Code Management

https://github.com/raml-org/raml-js-parser-2

Download raml-1-parser

Filename Size
raml-1-parser-1.1.43.pom
raml-1-parser-1.1.43.jar 5 MB
raml-1-parser-1.1.43-sources.jar 22 bytes
raml-1-parser-1.1.43-javadoc.jar 22 bytes
Browse

How to add to project

<!-- https://jarcasting.com/artifacts/org.webjars.npm/raml-1-parser/ -->
<dependency>
    <groupId>org.webjars.npm</groupId>
    <artifactId>raml-1-parser</artifactId>
    <version>1.1.43</version>
</dependency>
// https://jarcasting.com/artifacts/org.webjars.npm/raml-1-parser/
implementation 'org.webjars.npm:raml-1-parser:1.1.43'
// https://jarcasting.com/artifacts/org.webjars.npm/raml-1-parser/
implementation ("org.webjars.npm:raml-1-parser:1.1.43")
'org.webjars.npm:raml-1-parser:jar:1.1.43'
<dependency org="org.webjars.npm" name="raml-1-parser" rev="1.1.43">
  <artifact name="raml-1-parser" type="jar" />
</dependency>
@Grapes(
@Grab(group='org.webjars.npm', module='raml-1-parser', version='1.1.43')
)
libraryDependencies += "org.webjars.npm" % "raml-1-parser" % "1.1.43"
[org.webjars.npm/raml-1-parser "1.1.43"]

Dependencies

compile (25)

Group / Artifact Type Version
org.webjars.npm : http-response-object jar [2.0.3]
org.webjars.npm » json-schema-compatibility jar [1.1.0]
org.webjars.npm : z-schema jar [3.18.4]
org.webjars.npm : lrucache jar [1.0.3]
org.webjars.npm : pluralize jar [7.0.0]
org.webjars.npm : xmldom jar [0.1.27]
org.webjars.npm : fs-extra jar [4.0.2]
org.webjars.npm : loophole jar [1.1.0]
org.webjars.npm : media-typer jar [0.3.0]
org.webjars.npm : change-case jar [3.0.1]
org.webjars.npm : json-stable-stringify jar [1.0.1]
org.webjars.npm : q jar [1.5.0]
org.webjars.npm : xhr2 jar [0.1.4]
org.webjars.npm : typescript-compiler jar [1.4.1-2]
org.webjars.npm : xmlhttprequest jar [1.8.0]
org.webjars.npm : ts-structure-parser jar [0.0.16]
org.webjars.npm » ts-model jar [0.0.17]
org.webjars.npm : invariant jar [2.2.2]
org.webjars.npm : raml-definition-system jar [0.0.81]
org.webjars.npm : yaml-ast-parser jar [0.0.40]
org.webjars.npm : json-path jar [0.1.3]
org.webjars.npm : base64url jar [2.0.0]
org.webjars.npm : mkdirp jar [0.5.1]
org.webjars.npm : promise-polyfill jar [6.0.2]
org.webjars.npm : underscore jar [1.8.3]

Project Modules

There are no modules declared in this project.

DEPRECATION NOTICE: please note that this parser is now deprecated, please use webapi-parser instead.

—-

RAML 1.0 JS Parser

Build Status Greenkeeper badge

See http://raml.org for more information about RAML.

This parser supports both RAML 0.8 and 1.0.

Quick start

Install the parser: npm install raml-1-parser

Create 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

Installation

npm install raml-1-parser

node 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 node_modules/raml-1-parser/test/test01.js
  • For asynchrounous usage example refer to node_modules/raml-1-parser/test/testAsync01.js

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: git clone https://github.com/raml-org/raml-js-parser-2.git

Install modules: npm install

Build : npm run build

Generate browser package: npm run generateBrowserVersion, this will generate the package in browserVersion folder.

To generate debug-friendly browser package: npm run generateBrowserVersionDev

Setting up parser development environment

Clone repositories:

  • git clone https://github.com/mulesoft-labs/yaml-ast-parser.git
  • git clone https://github.com/mulesoft-labs/ts-model.git
  • git clone https://github.com/mulesoft-labs/ts-structure-parser.git
  • git clone https://github.com/raml-org/raml-typesystem.git
  • git clone https://github.com/raml-org/raml-definition-system.git
  • git clone https://github.com/raml-org/raml-js-parser-2.git

For each repository, preserving the order:

  • Install modules: npm install
  • Set up npm link: npm link

For each repository, preserving the order:

  • Open dependencies: cd node_modules
  • For each module <module_name> in node_modules belonging to the list above: rm -rf <module_name>
  • For each module <module_name> in node_modules belonging to the list above: npm link <module_name>

For each repository, preserving the order:

  • Build : npm run build

How to test: gulp test

Launching TCK tests

Execute npm run tck 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.

Contributing

If you are interested in contributing some code to this project, thanks! Please first read and accept the Contributors Agreement.

To discuss this project, please use its github issues or the RAML forum.

org.webjars.npm

RAML

The simplest way to model APIs

Versions

Version
1.1.43
1.1.8