https://github.com/udamir/api-ref-bundler-cli
https://github.com/udamir/api-ref-bundler-cli
Last synced: 10 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/udamir/api-ref-bundler-cli
- Owner: udamir
- License: mit
- Created: 2022-07-06T23:26:06.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2024-04-06T20:36:49.000Z (almost 2 years ago)
- Last Synced: 2025-01-14T06:47:45.448Z (12 months ago)
- Language: JavaScript
- Size: 417 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# api-ref-bundler-cli
This package provides cli tool to resolve all external references in Json based API document and bundle into single document
## Works perfectly with API specifications
- [JsonSchema](https://json-schema.org/draft/2020-12/json-schema-core.html)
- [Swagger 2.x](https://github.com/swagger-api/swagger-spec/blob/master/versions/2.0.md)
- [OpenApi 3.x](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md)
- [AsyncApi 2.x](https://www.asyncapi.com/docs/specifications/v2.4.0)
## Installation
```SH
npm i -g api-ref-bundler-cli
```
## Usage
```SH
ref-bundler [-f ] [-d ] [-t ]
```
#### Output formats: `yaml`, `json`
#### File type: `oas3` (default), `aas2`, `jsonschema`
---
## Contributing
When contributing, keep in mind that it is an objective of `api-ref-bundler-cli` to have no package dependencies. This may change in the future, but for now, no-dependencies.
Please run the unit tests before submitting your PR: `npm test`. Hopefully your PR includes additional unit tests to illustrate your change/modification!
## License
MIT