Skip to content
| Marketplace
Sign in
Visual Studio Code>Programming Languages>REST API ClientNew to Visual Studio Code? Get it now.

REST API Client

Unjin Jang

|
3,106 installs
| (2) | Free
Simple and intuitive API Client made into a VSCode extension.
Installation
Launch VS Code Quick Open (Ctrl+P), paste the following command, and press enter.
Copied to clipboard
More Info

REST API Client

Simple and intuitive API Client made into a VSCode extension.

Visual Studio Marketplace • Repository • Releases



Visual Studio Code extension to send basic HTTP/S requests and receive a response with an intuitive UI within Visual Studio code to enhance work productivity.

REST API Client preview

  • 🚀 Installation
  • ✨ Features
  • 💻 Commands
  • 📚 Tech Stacks
  • 🗒 Changelog
  • 👨🏻‍💻 Contributing
  • 🫧 Contributors
  • 📋 License

🚀 Installation

❗️ This extension is best paired with a dark-colored Visual Studio Code theme.

❗️ REST API Client cannot be installed or used when using a web version of Visual Studio Code

🔐 Security and Privacy

  • REST API Client does not collect or store any of your personal information or request data
  • REST API Client uses VSCode global state API in order to store your request history and favorites collections locally.

✨ Features

  • Send a request and receive a response from your desired API endpoint.
  • Five request method
    • GET
    • POST
    • PUT
    • PATCH
    • DELETE
  • Various request options
    • Add parameter to your API endpoint
    • Add authorization option
      • Basic Authorization
      • Bearer Token
    • Add body data
      • Form data
      • x-www-form-urlencoded
      • Raw data
        • Text
        • JavaScript
        • JSON
        • HTML
  • Code snippet of your current request, provided up to 18 different languages with their specific variants, to copy and paste to your codebase.

Code Snippet preview

  • Resizable vertical menu
  • Various response body view format
    • Pretty
      • JSON
      • HTML
      • Text
    • Raw
      • Plain Text
    • Visual HTML preview of the response data
  • Basic metadata information
    • Status code and text
    • Response size
    • Approximate time measurement to receive a response from your request
  • Copy and paste code button
  • Response headers view mode
  • History collection sidebar
  • Favorites collection sidebar
  • Intuitive icon UI to favorite a request history or delete
  • Search bar to find your specific request history
  • Click and search from the sidebar collection

Sidebar preview

💻 Commands

Simply click Open Menu button or open the Command Palette and type the command below:

Command+P or Command + Shift + P on macOS and Ctrl+Shift+P on Windows/Linux


Command Description
> Start: New Request Create a API Client menu

❗️ You can only create one panel at a time.

📚 Tech Stacks

This project was created using the following tech stacks:

           

  • Extension : VS Code Extension API
  • UI : React JS, Styled Components
  • HTTP/s Request: Axios
  • State Management Library: Zustand
  • Editor : Monaco Editor
  • Local DB : VSCode extension global state API
  • Code Snippet Generator : Postman-collection, Postman-Code-Generators
  • Bundler: Webpack
  • Compiler: Babel
  • Test: Jest, React Testing Library

🗒 Changelog

Current version 1.1.0

Visit here for a detailed release notes

👨🏻‍💻 Contributing

If you have a suggestion that would make this project better, please fork this repository from here and create a pull request.

I appreciate even the tiniest suggestion or contribution you make to this project.

🪜 Step-by-step guide on how to make a pull request

  1. Fork this Project from here
  2. Create your Branch → git checkout -b feature/newFeature
  3. Code up your outstanding logic → console.log("Hello World")
  4. Commit your Changes → git commit -m "feat: Add some newFeature"
  5. Push to the Branch → git push origin feature/newFeature
  6. Vist your GitHub repository and open a Pull Request

🏗 Running the extension locally for development

  1. Run git clone from this repository
  2. Run npm install in order to install all the dependencies needed
  3. Run npm webpack-dev
  4. Press F5 to launch extension development mode

⚠️ Bugs or Suggestions

If you found any bugs while using this extension or you have a suggestion please post it in issues.

🫧 Contributors

  • Unjin Jang
  • Cxxshyy
  • sergptz

📋 License

This extension is released under the MIT license.

  • Contact us
  • Jobs
  • Privacy
  • Terms of use
  • Trademarks
© 2023 Microsoft