Quick Reference

Commands

bash

oapie init

bash

oapie parse <source>

bash

oapie generate sdk <source>

Common Parse Flags

--output=pretty|json|js
--shape=raw|openapi
--browser=axios|happy-dom|jsdom|puppeteer
--crawl
--base-url=<url>

Common SDK Flags

--dir=<path>
--output-mode=runtime|classes|both
--signature-style=grouped|flat
--namespace-strategy=smart|scoped
--method-strategy=smart|operation-id
--crawl

Config File Names

oapiex.config.ts
oapiex.config.js
oapiex.config.cjs

Output Location

All parse results are written under:

text

./output

Defaults

Browser: puppeteer
Request timeout: 50000

Links