Skip to content
This repository has been archived by the owner on Jan 21, 2024. It is now read-only.
/ webapi-parser Public archive

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

License

Notifications You must be signed in to change notification settings

raml-org/webapi-parser

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ffe519b Β· Feb 12, 2022
Mar 18, 2020
Mar 24, 2020
Jan 31, 2020
Jan 14, 2020
Dec 17, 2019
Dec 17, 2019
May 26, 2020
Dec 17, 2019
Oct 28, 2019
Nov 1, 2018
Sep 17, 2019
Feb 12, 2022
May 13, 2019
Oct 30, 2018
Aug 21, 2020
Jan 31, 2020
May 14, 2019

Repository files navigation

webapi-parser

Build status Coverage Status

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 NPMJS Maven Central
Examples JavaScript examples Java examples
Developer Documentation JavaScript Typedoc Javadocs

πŸ“¦ Examples

πŸ›  Installation

JavaScript

Install the npm package:

$ npm install webapi-parser

and require/reference as follows:

const wap = require('webapi-parser').WebApiParser

Usage examples are located in the examples directory.

Java

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

Gradle:

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:

<dependency>
    <groupId>org.raml</groupId>
    <artifactId>webapi-parser</artifactId>
    <version>X.Y.Z</version>
</dependency>
...
<repositories>
    <repository>
        <id>MuleSoftReleases</id>
        <url>https://repository-master.mulesoft.org/nexus/content/repositories/releases</url>
    </repository>
    <repository>
        <id>jitpack.io</id>
        <url>https://jitpack.io</url>
    </repository>
</repositories>

To install snapshot versions set additional Sonatype snapshots repository.

Gradle:

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

Maven:

...
<repositories>
    ...
    <repository>
        <id>SonatypeSnapshots</id>
        <url>https://oss.sonatype.org/content/repositories/snapshots</url>
    </repository>
</repositories>

Usage examples are located in the examples directory.


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