Skip to content

Repository files navigation

API Explorer

License: MIT

A production-quality API workspace for exploring, documenting, configuring, sending, and inspecting HTTP requests.

Built with Next.js, TypeScript, Tailwind CSS, and shadcn/ui.

Features

  • Request builder (method, URL, params, headers, cookies, auth, body)
  • Response inspector (pretty JSON, headers, cookies, search)
  • Collections with one-level folders, favorites, and history
  • Environments with {{variable}} substitution
  • 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
  • OpenAPI 3 import (experimental)
  • Light / dark theme
  • Demo mocks for api.demo.local plus live proxy for other hosts

Screenshots / demo

Screenshots coming soon. Run the app locally with pnpm dev to try the workspace UI.

Tech stack

  • Next.js (App Router) and React
  • TypeScript
  • Tailwind CSS and shadcn/ui
  • Zustand for client state
  • pnpm for package management

Installation

Prerequisites: Node.js 20+ and pnpm.

git clone https://github.com/mohsen104/api-explorer.git
cd api-explorer
pnpm install

Development

pnpm dev      # development server → http://localhost:3000
pnpm build    # production build
pnpm start    # run production build
pnpm lint     # ESLint

More detail: docs/development.md.

How requests work

  1. Demo host — Requests to https://api.demo.local (and matching localhost paths) are answered by client-side mocks.
  2. Other hosts — Requests are sent through POST /api/proxy, which performs the outbound HTTP call server-side.

Environments

Use {{baseUrl}}, {{accessToken}}, and other variables in URLs, headers, and bodies. Unresolved variables are highlighted before send.

OpenAPI import

Import OpenAPI 3 JSON or YAML to generate a collection, folders (by tag), saved requests, and documentation. Labeled experimental — not a full OpenAPI tooling suite.

Notes

  • OAuth 2.0 UI supports pasting an access token only (no redirect/PKCE).
  • Multipart form-data file uploads are simulated in the demo path.
  • Sharing copies request configuration to the clipboard; shareable links require a backend.

Roadmap

See docs/roadmap.md for completed work, planned improvements, and future ideas.

Contributing

Contributions are welcome — bug fixes, docs, UX polish, and carefully scoped features.

  1. Read CONTRIBUTING.md
  2. Follow the Code of Conduct
  3. Open an issue (or claim a good first issue) before large changes
  4. Submit a pull request using the repository template

Security reports: see SECURITY.md.

License

This project is licensed under the MIT License.

Author

Mohsen Karimvandgithub.com/mohsen104

Open-source invitation

API Explorer is built to be a clear, modern HTTP workspace you can run locally and improve with the community. If you find a rough edge, spot a docs gap, or want to help with a good first issue, please jump in — maintainers and first-time contributors are all welcome.

About

A modern, open-source API testing and exploration tool built for developers.

Topics

Resources

Code of conduct

Contributing

Security policy

Stars

18 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages