REST TEST

A Visual Studio Code extension for testing REST APIs directly from your editor with a clean and intuitive interface.

Features

• Simple and Intuitive Interface: Clean, user-friendly interface for making HTTP requests

• Support for Multiple HTTP Methods:

  • GET
  • POST
  • PUT
  • DELETE
  • PATCH

• Request Configuration:

  • URL input with validation
  • Query parameters builder
  • Custom headers management
  • JSON body editor

• Advanced Features:

  • Auto-save of your last request configuration
  • JSON response formatting
  • Error handling with clear messages
  • Request state persistence across sessions
  • Real-time request status updates

Installation

1. Open Visual Studio Code
2. Press Ctrl+P (Windows/Linux) or Cmd+P (macOS)
3. Type ext install gopher-amol.rest-test
4. Press Enter

Usage

1. Open Command Palette (Ctrl+Shift+P or Cmd+Shift+P)
2. Type "REST TEST" and select it
3. The REST TEST interface will open in a new tab

Making Requests

1. Select HTTP Method:

   • Choose from the dropdown: GET, POST, PUT, DELETE, or PATCH

2. Enter URL:

   • Input the full URL of your API endpoint
   • The extension validates the URL format

3. Add Query Parameters (Optional):

   • Click "Add Query Parameter"
   • Enter key-value pairs
   • Parameters are automatically appended to the URL

4. Add Headers (Optional):

   • Click "Add Header"
   • Enter key-value pairs for custom headers
   • Common headers like Content-Type are supported

5. Add Request Body (Optional):

   • For POST, PUT, and PATCH requests
   • Enter valid JSON in the body textarea
   • JSON validation is performed before sending

6. Send Request:

   • Click the "Send Request" button
   • View the response in the panel below

Response Handling

• Success Responses:

  • Status code and status text displayed
  • Response body formatted as pretty JSON
  • Easy to read color-coded display

• Error Responses:

  • Clear error messages
  • HTTP error status codes
  • Network error handling
  • JSON parsing error detection

State Management

The extension automatically saves:

• Last used HTTP method
• Previous URL
• Query parameters
• Headers
• Request body

This state persists across VS Code sessions for convenience.

Requirements

• Visual Studio Code version 1.95.0 or higher
• Internet connection for making API requests

Extension Settings

Currently, this extension doesn't require any additional settings. All functionality is available out of the box.

Known Issues

Please report any issues on the GitHub repository.

Release Notes

2.6.0

Initial release of REST TEST with:

• Basic HTTP methods support
• Query parameters and headers management
• JSON body editor
• Response formatting
• State persistence
• Copy Request as cURL
• Copy JSON Response

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

License

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

Enjoy testing your REST APIs with REST TEST!