Skip to main content

Start

1. VS Code Extension Overview​

🎉 EchoAPI for VS Code is a lightweight and fast tool designed to help developers efficiently debug, test, and manage API documentation

Key Features:​

  • Easy to Use: Get started quickly and conveniently.

  • Comprehensive Features: Supports API debugging, testing, and documentation management to meet various development needs.

  • Offline Support: Use it anytime, anywhere, without needing to log in.

  • Local Storage: Ensures data privacy, with all information stored locally.

  • One-Click Sync: Easily back up data to the EchoAPI Client, eliminating the hassle of copying and pasting.

Target Audience:​

This plugin is suitable for developers, testers, and anyone who needs to interact with APIs. Whether you are a beginner or an experienced professional, you will benefit from it.

2. Installation and Setup​

Installation Steps:​

  • Open VS Code.
  • Go to the Extensions Marketplace: In the search box, type "EchoAPI for VS Code" or directly visit the following link: EchoAPI for VS Code.
  • Once you find the plugin, click the “Install” button.
  • Follow the on-screen instructions to complete the installation.

Verify Installation:​

  • After installation, restart VS Code.
  • Check the sidebar for the Extensions icon to confirm that “EchoAPI” appears in your extension list.
  • If the extension icon does not show, try refreshing the list manually or restarting VS Code again.

image.png

tip

If you encounter any issues during installation, check your network connection, ensure VS Code is updated to the latest version, or try reinstalling the plugin. You can manage the plugin by clicking the gear icon next to it to disable, uninstall, or update it as needed.

3. Create a new HTTP request​

Enter the EchoAPI for VS Code, and create a new request. image.png

4. Create a new folder​

Enter the EchoAPI for VS Code, and create a new folder. image.png

5. User Login and Account Management​

🔥 Usage without logging in is supported! 🔥

Login Scenarios:​

  • Switch between cloud teams and projects
  • Pull or push data to/from local or cloud storage

Login Access:​

  • Click "..." next to the product name, then select "Manage Account" to access the login interface.
  • From the “Team” dropdown list, choose “Sign in to EchoAPI” to enter the login screen. image.png

Login:​

  • In the login interface, click “Sign In.”
  • You will be redirected to the web login page, where you can log in using Google, GitHub, or your email and password. image.png
  • After a successful login, the system will automatically return you to VS Code. image.png

Logout:​

In the login interface, click “Sign Out - Clear Data” to log out. ❗️❗️❗️ Please note that this action will remove cloud project data from your local list, requiring you to log in again to access the cloud data. image.png