Skip to content

roadmap.md

Latest commit

 

History

History
55 lines (40 loc) · 2.89 KB

roadmap.md

File metadata and controls

55 lines (40 loc) · 2.89 KB
Raw

Roadmap

This roadmap is based on the current API Explorer capabilities and the limitations already documented in the project. It is intentionally conservative: items that would require major new product surfaces are listed as future ideas.

Status last reviewed: July 2026.

Completed

  • Request builder (method, URL, params, headers, cookies, auth, body types)
  • Response inspector (status, timing, pretty JSON, headers, cookies, search)
  • Workspace tabs and request drafting with persisted Zustand state
  • Collections with one-level folders, favorites, and request history
  • Environments and {{variable}} substitution with unresolved-variable highlighting
  • Command palette (Cmd/Ctrl + K) and keyboard shortcuts
  • Code generation (cURL, Fetch, Axios, Python, Go, Java, PHP)
  • cURL import/export and native collection JSON import/export
  • Experimental OpenAPI 3 import (JSON/YAML → collection, folders by tag, saved requests)
  • Light / dark theme support
  • Demo client mocks for api.demo.local and server-side live proxy for other hosts
  • MIT license and baseline open-source community documentation

In Progress

  • Hardening the project for open-source collaboration (templates, CI, contributor docs)
  • Continued polish of the experimental OpenAPI import path based on real-world specs

Planned

These are realistic next steps grounded in existing code and known gaps called out in the README:

  • Improve OpenAPI 3 import reliability and coverage beyond the current experimental label
  • Clearer proxy error messaging and safer defaults around outbound request failures
  • Better handling of multipart / form-data flows outside the demo mock path
  • Expand contributor-facing docs (examples, architecture diagrams as needed)
  • Introduce an automated test baseline for critical libs (URL building, variable substitution, cURL parse/export, collection IO)
  • Keep a changelog and semantic version tags as releases are cut

Future Ideas

Uncertain or larger efforts that are not committed. Do not treat these as near-term promises:

  • Full OAuth 2.0 authorization flows (redirect / PKCE); today the UI supports pasting an access token only
  • Shareable request links and multi-user collaboration (would require a backend beyond the current proxy)
  • Cloud sync of collections and environments across devices
  • GraphQL or WebSocket workspaces
  • Broader API-spec support (for example deeper Swagger/AsyncAPI tooling beyond current import experiments)
  • Plugin or extension system for custom auth and codegen targets

How to influence the roadmap

See also CONTRIBUTING.md and development.md.