https://github.com/jpeggdev/api-dev-studio
https://github.com/jpeggdev/api-dev-studio
Last synced: 5 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/jpeggdev/api-dev-studio
- Owner: jpeggdev
- Created: 2026-02-02T02:13:33.000Z (5 months ago)
- Default Branch: master
- Last Pushed: 2026-02-08T02:33:54.000Z (5 months ago)
- Last Synced: 2026-02-08T02:34:50.152Z (5 months ago)
- Language: HTML
- Size: 2.43 MB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# API Dev Studio
**The all-in-one local API development tool.**
Mock REST APIs, receive webhooks, and proxy real APIs with a beautiful unified interface. Works offline, stays private, one-time purchase.
---
## 🗂️ Repository Structure
This repository contains the **desktop application**:
```
api-dev-studio/
├── src/ React frontend
│ ├── components/ UI components
│ ├── contexts/ React contexts (Theme)
│ ├── hooks/ Custom hooks
│ ├── services/ Tauri API services
│ └── types/ TypeScript types
├── src-tauri/ Rust backend
│ ├── src/
│ │ ├── commands/ Tauri commands
│ │ ├── db/ Database operations
│ │ ├── models/ Data models
│ │ ├── server/ HTTP server management
│ │ └── openapi/ OpenAPI parser
│ └── icons/ App icons
├── server/ Express.js HTTP server
├── docs/ Planning documents
├── public/ Static assets
├── package.json Dependencies
├── README.md This file
└── CLAUDE.md AI assistant instructions
```
**Landing page**: Separate repository at [apidevstudio.com](https://apidevstudio.com)
---
## 🚀 Quick Start
### Prerequisites
- **Node.js** 18+
- **Rust** 1.70+
- **Bun** (preferred) or npm
### Development
```bash
# Install dependencies
bun install
# Run development server
bun run tauri:dev
# Build production app
bun run tauri:build
# Run frontend only (no Tauri)
bun run dev
# Type check
bun run build
```
---
## 🏗️ Current Status
**Phase**: Active Development
### ✅ Completed Features
**Project Management**
- Create, edit, delete projects
- Start/stop HTTP server per project
- Configurable port with availability checking
- Auto-find available port if preferred port is in use
**Mock API Endpoints**
- Create REST endpoints (GET, POST, PUT, PATCH, DELETE, OPTIONS, HEAD)
- Path parameters (`:id`, `:userId`, etc.)
- Custom status codes and headers
- JSON response body editor
- Response variations (static, sequential, random, conditional)
- Auto-save while editing
**Proxy & Recording**
- Proxy requests to external APIs
- Record all proxied responses
- Convert recordings to mock endpoints
- Duplicate detection with merge/update options
- Live/Mock mode toggle per proxy
**Request Inspector**
- Real-time request feed with auto-refresh
- Filter by HTTP method
- Star/bookmark important requests
- Delete individual or all requests
- Detailed view (headers, body, response)
**OpenAPI Import**
- Import OpenAPI 3.x specs (YAML/JSON)
- Preview before import
- Overwrite existing endpoints option
**Desktop App**
- Dark mode and Light mode themes
- System tray integration
- Close-to-tray option
- Settings panel
- Sidebar navigation
- Responsive layout
**HTTP Server**
- Express.js-based server
- CORS enabled by default
- Dynamic routing based on endpoints
- Request/response logging
**Database**
- SQLite for persistent storage
- Projects, endpoints, requests, recordings, settings
### 🚧 In Progress / Coming Soon
- Template variables (`{{faker.name}}`, `{{uuid}}`)
- Webhook receiver endpoints
- Response delays
- Search in request inspector
- Export requests (JSON, CSV)
- Keyboard shortcuts
- CLI tool
---
## 📚 Documentation
**Key Documents** (in `docs/` folder):
- `api-dev-studio-prd.md` - Product Requirements
- `api-dev-studio-architecture.md` - Technical Architecture
- `api-dev-studio-ui-ux-design.md` - Design System
- `api-dev-studio-roadmap.md` - Feature Roadmap
- `api-dev-studio-project-management.md` - Workflows
---
## 🎯 Project Goals
### Vision
Build the essential local-first API development tool that replaces webhook.site, Postman mock servers, and json-server with a single beautiful desktop application.
### Value Proposition
- **All-in-One**: Mock APIs + Webhooks + Proxy in one tool
- **Local-First**: 100% private, works offline
- **Beautiful UX**: Modern desktop app, not CLI
- **Smart Recording**: Auto-generate mocks from real API traffic
- **Fair Pricing**: One-time purchase ($49), not subscription
---
## 🛠️ Tech Stack
### Desktop App
- **Framework**: Tauri 2.0 (Rust + WebView)
- **Frontend**: React 19, TypeScript, Vite
- **Styling**: Tailwind CSS v4
- **State**: React Context + useState
- **Backend**: Rust
- **HTTP Server**: Node.js + Express.js
- **Database**: SQLite (rusqlite)
### Key Dependencies
**Frontend:**
- React 19
- Tailwind CSS v4
- @tauri-apps/api
**Backend (Rust):**
- tauri 2.x
- rusqlite
- serde / serde_json
- tokio
- chrono
- uuid
**Server:**
- Express.js
- better-sqlite3
- cors
---
## 📋 Development Roadmap
### v1.0 - MVP (Target: Q2 2026)
- [x] Project management
- [x] Mock endpoints with variations
- [x] Proxy & recording mode
- [x] Request inspector
- [x] OpenAPI import
- [x] Dark/light themes
- [x] System tray
- [x] Settings panel
- [ ] Webhook receiver
- [ ] Template variables (Faker.js)
- [ ] Response delays
- [ ] CLI tool
- [ ] Export features
### v1.1 - Quick Wins
- Export to Docker, OpenAPI, Postman
- Advanced filtering
- Duplicate project/endpoint
- Performance optimizations
### v2.0 - Power Features
- GraphQL support
- WebSocket mocking
- Advanced authentication simulation
- Team collaboration features
- SOAP/RPC support
See `docs/api-dev-studio-roadmap.md` for full roadmap.
---
## 🤝 Contributing
This is currently a solo project in early development. Contributions will be welcome after v1.0 launch.
---
## 📝 License
License TBD (will be determined before v1.0 launch)
---
## 🔗 Links
- **Website**:
- **Documentation**: `docs/` folder
---
## 📞 Contact
**Creator**: Jeff Pegg
**Twitter**: @jpegg_dev
---
**Built with care for developers**
Last updated: January 13, 2026