Roadmap

This page collects likely future directions for OAPIEX. It is not a strict release plan, but it is the current list of areas that would add the most value.

Documentation Platform Support

ReadMe Improvements

• broader coverage for edge-case ReadMe layouts
• better handling for deeply nested request schemas
• stronger extraction of examples, response variants, and authentication metadata

Apidog Support

• detect and parse API reference pages generated by Apidog
• extract request and response examples from Apidog-specific page structures
• normalize Apidog docs into the same raw and OpenAPI output shapes already supported for ReadMe
• support crawl flows across Apidog navigation structures

Postman Documentation Support

• parse Postman public documentation pages and collections published as docs sites
• extract endpoint descriptions, parameters, headers, request bodies, and example responses
• map Postman docs concepts into stable OpenAPI operations
• support multi-page crawls for larger Postman documentation hubs

Output Quality

• improve schema inference for partial or collapsed examples
• preserve more response metadata such as content types and example variants
• infer security schemes and authentication requirements when the docs expose them
• reduce placeholder or low-confidence operations even further

Programmatic API

• stabilize the public library export surface for import { ... } from 'oapiex'
• expose higher-level helpers for one-call extraction and transformation
• publish richer TypeScript types for extracted operations and OpenAPI output
• support configurable logging hooks for embedding OAPIEX in other tools

CLI And Config

• add first-class config for inclusion and exclusion rules during crawl
• support custom output paths and file naming strategies
• add machine-readable summary output for CI pipelines
• expand debug surfaces beyond the current SDK HTTP controls (client.debug(level) and init-time debugLevel)

Performance And Reliability

• improve concurrency controls for large crawls
• add smarter retry behavior for flaky remote docs sites
• cache repeated page loads during iterative extraction work
• improve memory use when processing large documentation trees

Developer Experience

• publish more fixtures and regression tests for real-world documentation sites
• add end-to-end examples for package usage inside Node scripts
• document supported doc-platform behaviors and known limitations more explicitly
• provide migration notes as support expands beyond ReadMe

Notes

• Apidog support and Postman docs support are both strong candidates for future expansion.
• The roadmap is intentionally flexible and may change based on user demand and implementation cost.