API Workspace

Code-aware API development, testing, debugging, and monitoring — directly inside VS Code.

API Workspace is a powerful API development workspace built for developers who want to design, test, debug, replay, and monitor APIs without constantly switching between VS Code and external API tools.

How to Use API Workspace

1. Open your API Project: Open any backend project (Express, NestJS, FastAPI, Spring Boot, etc.) in VS Code.
2. Open the Sidebar: Click the new API Workspace icon in the left Activity Bar.
3. Explore your APIs: The API Explorer panel will automatically scan your project and list all your API endpoints grouped logically (e.g., Auth, Users, Products).
4. Start the Server: In the Project Overview panel, right-click the "Server" item and select Start Server. It will auto-detect your start script (e.g., npm run dev) and your port from your .env file.
5. Test an Endpoint: Click on any endpoint in the API Explorer (e.g., POST /login). A rich Request Builder tab will open.
6. Send Requests: Fill in your Body, Headers, or Query Params, and click Send. The response body, status code, and time taken will appear instantly.
7. Save to Collection: Right-click any endpoint in the explorer to save it to a custom collection for easy access later.
8. View History: Check the History panel in the sidebar to see and replay your recent requests.

Features

API Testing

Test your APIs directly from VS Code.

• Send HTTP requests
• Test GET, POST, PUT, PATCH, and DELETE APIs
• View response status
• Inspect response headers
• Inspect response body
• Measure response time
• Debug API failures quickly

Start & Stop Your Development Server

Manage your local API server directly from the API Workspace sidebar.

• Start server
• Stop server
• View server status
• Quickly access your API routes

No need to leave VS Code to manage your development server.

Request Replay

Easily replay previous API requests.

Useful when debugging:

• Authentication issues
• API errors
• Database operations
• Request payload problems
• Backend changes

API Explorer

Explore your project's API routes from inside VS Code.

Quickly discover and interact with your backend endpoints without manually searching through your source code.

Collections

Save frequently used API requests into collections.

Organize your APIs by:

• Project
• Feature
• Service
• Environment
• API version

Example:

📁 User APIs
   ├── Login
   ├── Register
   ├── Get Profile
   └── Update Profile

📁 Product APIs
   ├── Create Product
   ├── Get Products
   ├── Update Product
   └── Delete Product