Package Exports

apib2swagger

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (apib2swagger) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

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, 11.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
$ apib2swagger -i api.md --bearer-apikey

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, bearerAsApikey: false };

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

npx

You can run apib2swagger via npx (without first needing to install it) like so:

cat api.md | npx apib2swagger > swagger.json

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

MIT