webapi-parser


API Spec parser based on AMF. Currently supports RAML 0.8, RAML 1.0, OAS 2.0 and OAS 3.0(beta).

This project is a thin wrapper that exposes API Spec-related capabilities from AMF. It is written in Scala and offered in two versions: JavaScript and Java.

📃 Documentation

| | JavaScript | Java |
| ---- | ---------- | ---- |
| Installation | NPM | Gradle/Maven |
| Object-oriented interface | "WebApi" Model | "WebApi" Model |
| Package |  |  |
| Examples | JavaScript examples | Java examples |
| Developer Documentation | JavaScript Typedoc | Javadocs |

📦 Examples

* Resolving a "WebApi" Model
* Navigating a "WebApi" Model
* Constructing a "WebApi" Model
* Translating RAML DataTypes to JSON Schemas
* Translating JSON Schemas to RAML DataTypes
* More examples

🛠 Installation

$3

Install the npm package:

``sh
$ npm install webapi-parser
`

and require/reference as follows:
`js
const wap = require('webapi-parser').WebApiParser
`

Usage examples are located in the examples directory.

$3


Specify webapi-parser as a dependency and set both MuleSoft and Jitpack repositories.

Gradle:
`groovy
dependencies {
compile 'org.raml:webapi-parser:x.y.z'
}
...
repositories {
maven {
url "https://repository-master.mulesoft.org/nexus/content/repositories/releases"
}
maven {
url "https://jitpack.io"
}
mavenCentral()
}
`

Maven:
`xml

org.raml
webapi-parser
X.Y.Z

...


MuleSoftReleases
https://repository-master.mulesoft.org/nexus/content/repositories/releases


jitpack.io
https://jitpack.io


`

To install snapshot versions set additional Sonatype snapshots repository.

Gradle:
`groovy
...
repositories {
...
maven {
url 'https://oss.sonatype.org/content/repositories/snapshots'
}
}
`

Maven:
`xml
...

...

SonatypeSnapshots
https://oss.sonatype.org/content/repositories/snapshots


``

Usage examples are located in the examples directory.

---

If you wish to contribute to this project, please review our Contribution Guidelines.