Convert API Blueprint to Swagger.
Supported versions:
- API Blueprint 1A9
- Metadata section
- HOST -> .host, .basePath, .schemes
- VERSION -> .info.version
- Include directive
- Metadata section
- Swagger 2.0
- Node.js 8.x, 10.x, 12.x or higher
$ npm install -g apib2swagger
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);
});
You can run apib2swagger via npx
(without first needing to install it) like so:
cat api.md | npx apib2swagger > swagger.json
You can also run apib2swagger inside a docker container.
$ docker run -it --rm -v $(pwd):/docs kminami/apib2swagger -i /docs/api.md -o /docs/swagger.json
Copyright (c) 2015 Keisuke Minami
MIT