Eoyo/apib2swagger

Convert API Blueprint to Swagger.

apib2swagger

Convert API Blueprint to Swagger.

Supported versions:

• API Blueprint 1A9
  • Metadata section
    • HOST -> .host, .basePath, .schemes
    • VERSION -> .info.version
  • Include directive
• Swagger 2.0
• Node.js 6.x, 8.x, 9.x, 10.x or higher

Install

$ npm install -g apib2swagger

Usage

Convert to Swagger specification.

$ apib2swagger -i api.md
$ apib2swagger -i api.md -o swagger.json
$ apib2swagger -i api.md --yaml -o swagger.yaml
$ apib2swagger -i api.md --prefer-reference

Without -i option it reads from STDIN, without -o option writes to STDOUT.

$ apib2swagger < api.md > swagger.json
$ cat api.md | apib2swagger

Run http server with SwaggerUI. SwaggerUI will be automatically downloaded to current dir.

$ apib2swagger -i api.md -s
$ apib2swagger -i api.md -s -p 3000

Use as a library.

var apib2swagger = require('apib2swagger'),
    apib = '...',
    options = { preferReference: true };

apib2swagger.convert(apib, options, function (error, result) {
    if (!error) console.log(result.swagger);
});

Docker

You can also run apib2swagger inside a docker container. (Unofficial image, use it carefully)

$ docker run -it --rm -v $(pwd):/docs cbarraford/apib2swagger -i api.md -o swagger.json

License

Copyright (c) 2015 Keisuke Minami

MIT