Skip to content
A utility to generate RAML documentation from Swagger JSON
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
gradle/wrapper
src Optional support in query parameters Sep 11, 2014
.gitignore
.travis.yml Groovy in .travis.yml Sep 18, 2014
CONTRIBUTING.md updating project with instructions for community contributions May 27, 2014
LICENSE.md
README.md appveyor build config Jan 15, 2015
appveyor.yml
build.gradle swagger2raml release to Maven Central Oct 27, 2014
gradlew Gradle build files May 21, 2014
gradlew.bat
settings.gradle

README.md

swagger2raml Build Status Windows Build Status Get automatic notifications about new "swagger2raml" versions

A utility to generate RAML documentation from Swagger JSON.

Usage

swagger2raml can be used either from command line (requires Java to be on the PATH) or as a Java library.

Command line

java -jar swagger2raml-1.0.0.jar [-o outputFileName] <swaggerApiUrl>

where:

  • outputFileName is an optional parameter to specify the RAML file name (default is api.raml),
  • swaggerApiUrl is the URL of the Swagger API endpoint which provides resource listing as JSON.

Your application

RamlGenerator.generateFromSwaggerUrl(String url, String outputFileName)

method with the parameters as described in the command line usage.

Grab the JAR from Maven (Bintray or Maven Central repository) or use the bundled one:

Gradle

repositories {
    mavenCentral()
}

compile 'com.8x8.cloud:swagger2raml:1.0.0'

Maven

<dependency>
    <groupId>com.8x8.cloud</groupId>
    <artifactId>swagger2raml</artifactId>
    <version>1.0.0</version>
</dependency>

Bundled JAR

Add swagger2raml-1.0.0-bundled.jar from Releases to your CLASSPATH

Contributing to this project

Anyone and everyone is welcome to contribute. Please take a moment to review the guidelines for contributing.

License

You can’t perform that action at this time.