API Documenter is a robust alternative to Postman and Insomnia, designed specifically for developers who value privacy, speed, and ownership. It starts as a high-performance local desktop app but scales instantly into a team-oriented platform with secure database synchronization and granular role-based access control.
- Local Storage: Your sensitive API data stays on your machine by default using high-speed IndexedDB (Dexie).
- Zero Latency: No "cloud sync" lag while you're prototyping or testing locally.
- Privacy by Design: No mandatory accounts or telemetry.
- Multi-DB Support: Connect your workspace to a remote PostgreSQL or MySQL server.
- Vercel Proxy Deployment: Deploy a production-ready server to Vercel in one click. This ensures your DB credentials are never exposed to the client side and all team traffic is securely authorized.
- Real-time Sync: Collaborative editing with bi-directional synchronization between local and remote states.
- Admin: Full control over project infrastructure, sync settings, and team management.
- Editor: Full read/write access to folders, requests, and documentation.
- Viewer: Read-only access for team members who need to consume documentation without modification.
- Full HTTP Support: GET, POST, PUT, DELETE, PATCH, OPTIONS, and more.
- Rich Payloads: Seamlessly handle Headers, Query Params, and JSON/Text bodies.
- Smart Response Viewer: Real-time status codes, response headers, body size, and execution benchmarks.
- Premium UI: Sleek, glassmorphic dark-themed design.
- Custom Font Scaling: Perfectly tailored readability for any screen size, from laptop screens to 4K monitors.
- GitHub Auto-Updates: Silent background updates that keep you on the latest version without disruption.
- Frontend: React 18, TypeScript, Vite
- Desktop Layer: Electron (Standard IPC Integration)
- State Management: Zustand & React Query
- Local Database: Dexie (IndexedDB)
- Remote Bridge: mysql2, pg (via Secure Proxy)
- CI/CD: GitHub Actions & Electron-Builder
-
Clone the repository:
git clone https://github.com/PraneethKulukuri26/API-Documenter.git cd API-Documenter -
Install dependencies:
npm install
-
Start Development Server:
npm run dev
-
Build Production Application:
# Build for Windows npm run build:win # Build for macOS npm run build:mac
API Documenter uses a unique Security Proxy Architecture. When you connect a database, the app deploys a serverless function to Vercel. This function acts as the sole gatekeeper for your database, ensuring that raw SQL credentials are never stored in the desktop application but remain securely in your Vercel environment variables.
For more details, see SECURITY.md.
We love contributions! Please read our CONTRIBUTING.md to get started.
Distributed under the MIT License. See LICENSE for more information.