REST Client for VS Code

A powerful and elegant REST API client built directly into Visual Studio Code. Test APIs, manage collections, and integrate seamlessly with Salesforce - all without leaving your editor.

Screenshots

✨ Features

🚀 Core Functionality

• HTTP Methods: Support for GET, POST, PUT, DELETE, and PATCH requests
• Custom Headers: Add unlimited custom headers with an intuitive table interface
• Request Body: Send JSON, XML, or any text-based payload
• Response Viewer: Beautiful Monaco Editor integration with JSON syntax highlighting
• Language Toggle: Switch between JSON and plain text views instantly

📦 Collections Management

• Save Requests: Store your API requests as named collections
• Quick Load: Load saved collections with a single click
• Persistent Storage: Collections are saved in your workspace state

🔐 Salesforce Integration

• One-Click Auth: Fetch Salesforce access tokens using Salesforce CLI
• Auto-Configuration: Automatically populates Authorization headers
• Session Management: Caches authentication data for quick reuse

🛠️ Developer Tools

• cURL Export: Generate cURL commands from your requests
• Copy Response: One-click copy to clipboard
• Save to File: Export responses directly to workspace files
• Response Time: Track API response times
• Status Indicators: Clear visual feedback for success/error states

🎨 User Experience

• Dark Theme: Beautiful dark mode interface that matches VS Code
• Scrollable Sections: 10-row header table and resizable body textarea
• Responsive Layout: Optimized layout that adapts to your workspace
• Keyboard Shortcuts: Press Enter to confirm in modal dialogs

📋 Prerequisites

• Visual Studio Code v1.70.0 or higher
• (Optional) Salesforce CLI (sf) for Salesforce authentication

🚦 Getting Started

Basic Usage

1. Open REST Client

   • Press Ctrl+Shift+P (or Cmd+Shift+P on Mac)
   • Type "REST Client: Open Panel"
   • Press Enter

2. Make Your First Request

   • Select HTTP method (GET, POST, etc.)
   • Enter the API URL
   • Add headers if needed (click "+ Add Header")
   • Add request body (for POST/PUT/PATCH)
   • Click "Send"

3. View Response

   • Response status and time appear at the bottom
   • Headers are shown in the Response Headers section
   • Body is displayed in the Monaco Editor with syntax highlighting

Using Collections

Save a Collection:

1. Configure your request (URL, headers, body)
2. Click the "Save" button
3. Enter a collection name
4. Press Enter or click "Save"

Load a Collection:

1. Click "Select Collection" in the sidebar
2. Choose from your saved collections
3. The request details will populate automatically

Salesforce Authentication

1. Setup:

   • Select "Salesforce" radio button under Auth
   • Enter your Salesforce username or org alias
   • Click "Fetch Token"

2. Make Requests:

   • The extension automatically adds Authorization header
   • Your instance URL is populated in the URL field
   • Standard Salesforce headers (Content-Type, Accept) are added

3. Example Request:

   URL: https://your-instance.salesforce.com/services/data/v60.0/sobjects/Account/describe
   Method: GET
   Headers: Automatically populated
   

Export as cURL

1. Send a request first
2. Click the "cURL" button
3. View the generated cURL command
4. Click "Copy to Clipboard"
5. Use in terminal or share with team

🎯 Use Cases

• API Development: Test your APIs during development
• API Testing: Validate endpoints and responses
• Salesforce Development: Query Salesforce REST APIs without leaving VS Code
• Documentation: Save and share API collections with your team
• Debugging: Inspect headers, status codes, and response bodies
• Integration Testing: Test third-party API integrations

⌨️ Keyboard Shortcuts

🔒 Privacy & Security

• Local Storage: All collections are stored in VS Code workspace state
• No External Servers: No data is sent to external servers
• Secure Auth: Salesforce tokens are retrieved via official CLI
• Session Cache: Auth tokens are cached locally in workspace state

📝 License

This project is licensed under the MIT License - see the LICENSE file for details.

Made with ❤️ by Mohan Chinnappan

Happy API Testing! 🚀