This repository is deprecated! Please use the official oas-raml-converter instead.
Takes a swagger spec and converts it into a RAML JavaScript object, usually for conversion to RAML with the raml-object-to-raml module.
npm install swagger-to-raml-object --saveQuickly get started converting swagger to RAML in your command line:
# Make sure node and npm are installed before continuing.
npm install swagger-to-raml-object -g
npm install raml-object-to-raml -g
# Convert a swagger spec into a raml object.
swagger-to-raml-object http://petstore.swagger.wordnik.com/api/api-docs
# Pipe the result of that into the raml object to raml converter.
swagger-to-raml-object http://petstore.swagger.wordnik.com/api/api-docs | raml-object-to-raml
# You can then output the result of that to a file.
swagger-to-raml-object http://petstore.swagger.wordnik.com/api/api-docs | raml-object-to-raml > output.ramlThe CLI accepts a single swagger file to load and will recursively compile the spec into a single RAML object representation before printing the JSON to stdout.
swagger-to-raml-object resources.json > raml.jsonThe module exports a single function for converting Swagger specifications. It accepts three arguments, the root resource listing, a file reader function and a callback for when parsing is complete. The callback is called with an error (if something occured) and the resulting RAML object.
var converter = require('swagger-to-raml-object');
converter(rootFile, function (filename, done) {
return fs.readFile(filename, 'utf8', done);
}, function (err, ramlObject) {
if (err) {
console.error(err);
}
console.log(ramlObject);
// {
// "title": "Example API",
// "resources": [{ ... }],
// ...
// }
});- Works with Swagger 1.2 (not 2.0 yet)
- Loads from any resource structure given a file reader function
- Does not parse XML bodies into schemas yet (only JSON and form)
- Does not do any RAML documentation optimisations such as
resourceTypes,traitsor globalschemas - Currently only does single file output
Apache 2.0
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent