darosh / openapi-directory-tools

OpenAPI Directory Tools

Structure

├─┬ APIs
│ └─┬ <PROVIDER>  
│   ├─┬ <SERVICE>          optional
│   │ ├─┬ <VERSION>
│   │ │ ├── fixup.yaml
│   │ │ ├── swagger.yaml
│   │ │ └── patch.yaml
│   │ └── patch.yaml
│   └── patch.yaml
└─┬ fixes
  └── fix

Usage

odt urls

odt urls -LL

odt add --url http://petstore.swagger.io/v2/swagger.json -s petstore -u

Development

$ npm run lint

Refactoring Notes

Code

• replace wget and makeRequest with got with RFC compliant caching (using file based SQL Lite)
• replace all synchronous calls for faster pipeline
• parallel downloads and git log
• use ES6 via gulpfile.babel.js (eventually @std/esm)
• use native features where possible (URL, Promise, promisify, ...)
• streamed tar.gz file list reading

CI

• Travis caching for faster build
• set env FORCE_COLOR=1 for colored gulp output
• set env AWS_ACCESS_KEY_ID & AWS_SECRET_ACCESS_KEY