https://github.com/mikeralphson/openapi-doc
OpenAPI (Swagger 2.0) document builder.
https://github.com/mikeralphson/openapi-doc
Last synced: 9 months ago
JSON representation
OpenAPI (Swagger 2.0) document builder.
- Host: GitHub
- URL: https://github.com/mikeralphson/openapi-doc
- Owner: MikeRalphson
- License: other
- Created: 2016-12-19T23:44:54.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2016-12-19T23:45:14.000Z (about 9 years ago)
- Last Synced: 2024-10-11T23:18:20.347Z (about 1 year ago)
- Homepage: https://www.axway.com/en/api-management-overview
- Size: 6.84 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# openapi-doc
   
OpenAPI (Swagger 2.0) document builder.
## Features
## Install
`npm install --save openapi-doc`
## Scripts
- **npm run build** : `if-env NODE_ENV=production && npm run build:prod || npm run build:dev`
- **npm run build:dev** : `npm run build:lint && npm run test && npm run build:readme && npm run build:doc && babel -d ./dist ./src`
- **npm run build:doc** : `esdoc -c esdoc.json`
- **npm run build:lint** : `eslint ./src`
- **npm run build:prod** : `npm prune --production`
- **npm run build:readme** : `node-readme`
- **npm run clean** : `rimraf dist coverage doc README.md`
- **npm run posttest** : `istanbul check-coverage coverage/coverage.json --line 80 --branch 80 --statement 80`
- **npm run release:publish** : `git add -A && git push && git push --tags && npm publish`
- **npm run release:major** : `npm version major && npm run release:publish && git push --follow-tags`
- **npm run release:minor** : `npm version minor && npm run release:publish && git push --follow-tags`
- **npm run release:patch** : `npm version patch && npm run release:publish && git push --follow-tags`
- **npm run release:prerelease** : `npm version prerelease && npm run release:publish && git push --follow-tags`
- **npm run test** : `rm -rf coverage && NODE_ENV=test istanbul cover _mocha -- -R spec`
## Dependencies
Package | Version | Dev
--- |:---:|:---:
[if-env](https://www.npmjs.com/package/if-env) | ^1.0.0 | ✖
[babel-cli](https://www.npmjs.com/package/babel-cli) | ^6.3.17 | ✔
[babel-eslint](https://www.npmjs.com/package/babel-eslint) | ^6.1.2 | ✔
[babel-preset-es2015](https://www.npmjs.com/package/babel-preset-es2015) | * | ✔
[chai](https://www.npmjs.com/package/chai) | ^3.5.0 | ✔
[esdoc](https://www.npmjs.com/package/esdoc) | ^0.4.8 | ✔
[eslint](https://www.npmjs.com/package/eslint) | ^3.5.0 | ✔
[eslint-config-airbnb](https://www.npmjs.com/package/eslint-config-airbnb) | ^11.1.0 | ✔
[eslint-plugin-import](https://www.npmjs.com/package/eslint-plugin-import) | ^1.15.0 | ✔
[eslint-plugin-jsx-a11y](https://www.npmjs.com/package/eslint-plugin-jsx-a11y) | ^2.2.2 | ✔
[eslint-plugin-react](https://www.npmjs.com/package/eslint-plugin-react) | ^6.2.2 | ✔
[istanbul](https://www.npmjs.com/package/istanbul) | ^0.4.5 | ✔
[mocha](https://www.npmjs.com/package/mocha) | ^3.0.2 | ✔
[node-readme](https://www.npmjs.com/package/node-readme) | ^0.1.8 | ✔
[rimraf](https://www.npmjs.com/package/rimraf) | ^2.5.4 | ✔
[swagger-parser](https://www.npmjs.com/package/swagger-parser) | ^3.4.1 | ✔
## Contributing
Contributions welcome; Please submit all pull requests the against master branch. If your pull request contains JavaScript patches or features, you should include relevant unit tests. Please check the [Contributing Guidelines](contributng.md) for more details. Thanks!
## Author
Axway https://axway.com
## License
- **SEE LICENCE IN LICENCE** : null