https://github.com/darosh/openapi-directory-tools
https://github.com/darosh/openapi-directory-tools
Last synced: 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/darosh/openapi-directory-tools
- Owner: darosh
- License: mit
- Created: 2017-12-02T12:08:22.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2017-12-02T18:53:21.000Z (over 7 years ago)
- Last Synced: 2025-01-25T16:41:57.040Z (4 months ago)
- Language: JavaScript
- Size: 85 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# OpenAPI Directory Tools
## Structure
```text
├─┬ APIs
│ └─┬
│ ├─┬ optional
│ │ ├─┬
│ │ │ ├── fixup.yaml
│ │ │ ├── swagger.yaml
│ │ │ └── patch.yaml
│ │ └── patch.yaml
│ └── patch.yaml
└─┬ fixes
└── fix
```
## Usage
```bash
odt urls
odt urls -LL
odt add --url http://petstore.swagger.io/v2/swagger.json -s petstore -u
```
## Development
```bash
$ npm run lint
```
## Refactoring Notes
### Code
- [x] replace `wget` and `makeRequest` with [got](https://github.com/sindresorhus/got) with RFC compliant caching (using file based SQL Lite)
- [x] replace all synchronous calls for faster pipeline
- [x] parallel downloads and `git log`
- [x] use ES6 via `gulpfile.babel.js` (eventually [@std/esm](https://github.com/standard-things/esm))
- [x] use native features where possible (`URL`, `Promise`, `promisify`, ...)
- [x] streamed `tar.gz` file list reading
### CI
- [x] [Travis caching](https://docs.travis-ci.com/user/caching/) for faster build
- [x] set env `FORCE_COLOR=1` for colored gulp output
- [x] set env `AWS_ACCESS_KEY_ID` & `AWS_SECRET_ACCESS_KEY`