https://www.echoapi.com/wiki/assets/js/6daff318.91ec4e9e.js

1"use strict";(self.webpackChunkmy_website=self.webpackChunkmy_website||[]).push([[5706],{5680:(e,t,n)=>{n.d(t,{xA:()=>s,yg:()=>m});var a=n(6540);function r(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function o(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function l(e){for(var t=1;t<arguments.length;t++){var n=null!=arguments[t]?arguments[t]:{};t%2?o(Object(n),!0).forEach((function(t){r(e,t,n[t])})):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(n)):o(Object(n)).forEach((function(t){Object.defineProperty(e,t,Object.getOwnPropertyDescriptor(n,t))}))}return e}function i(e,t){if(null==e)return{};var n,a,r=function(e,t){if(null==e)return{};var n,a,r={},o=Object.keys(e);for(a=0;a<o.length;a++)n=o[a],t.indexOf(n)>=0||(r[n]=e[n]);return r}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(a=0;a<o.length;a++)n=o[a],t.indexOf(n)>=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(r[n]=e[n])}return r}var g=a.createContext({}),p=function(e){var t=a.useContext(g),n=t;return e&&(n="function"==typeof e?e(t):l(l({},t),e)),n},s=function(e){var t=p(e.components);return a.createElement(g.Provider,{value:t},e.children)},c="mdxType",u={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},y=a.forwardRef((function(e,t){var n=e.components,r=e.mdxType,o=e.originalType,g=e.parentName,s=i(e,["components","mdxType","originalType","parentName"]),c=p(n),y=r,m=c["".concat(g,".").concat(y)]||c[y]||u[y]||o;return n?a.createElement(m,l(l({ref:t},s),{},{components:n})):a.createElement(m,l({ref:t},s))}));function m(e,t){var n=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var o=n.length,l=new Array(o);l[0]=y;var i={};for(var g in t)hasOwnProperty.call(t,g)&&(i[g]=t[g]);i.originalType=e,i[c]="string"==typeof e?e:r,l[1]=i;for(var p=2;p<o;p++)l[p]=n[p];return a.createElement.apply(null,l)}return a.createElement.apply(null,n)}y.displayName="MDXCreateElement"},744:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>g,contentTitle:()=>l,default:()=>u,frontMatter:()=>o,metadata:()=>i,toc:()=>p});var a=n(8168),r=(n(6540),n(5680));const o={slug:"/vscode/start"},l="EchoAPI for VS Code",i={unversionedId:"VS Code Plugin/Start",id:"VS Code Plugin/Start",title:"EchoAPI for VS Code",description:"EchoAPI is a lightweight and fast tool designed to help developers efficiently debug, test, and manage API documentation.",source:"@site/docs/16-VS Code Plugin/01-Start.md",sourceDirName:"16-VS Code Plugin",slug:"/vscode/start",permalink:"/wiki/docs/vscode/start",draft:!1,tags:[],version:"current",sidebarPosition:1,frontMatter:{slug:"/vscode/start"},sidebar:"docs",previous:{title:"Get Started",permalink:"/wiki/docs/start"},next:{title:"Import and Export",permalink:"/wiki/docs/vscode/import"}},g={},p=[{value:"1. Key Features",id:"1-key-features",level:2},{value:"2. Installation &amp; Setup",id:"2-installation--setup",level:2},{value:"Installation Steps",id:"installation-steps",level:3},{value:"Verifying Installation",id:"verifying-installation",level:3},{value:"3. User Login &amp; Account Management",id:"3-user-login--account-management",level:2},{value:"Login Scenarios",id:"login-scenarios",level:3},{value:"Login Access",id:"login-access",level:3},{value:"Login Steps",id:"login-steps",level:3},{value:"Logging Out",id:"logging-out",level:3},{value:"Support &amp;

1 Feedback",id:"support--feedback",level:2}],s={toc:p},c="wrapper";function u(e){let{components:t,...n}=e;return(0,r.yg)(c,(0,a.A)({},s,n,{components:t,mdxType:"MDXLayout"}),(0,r.yg)("h1",{id:"echoapi-for-vs-code"},"EchoAPI for VS Code"),(0,r.yg)("p",null,(0,r.yg)("strong",{parentName:"p"},"EchoAPI")," is a lightweight and fast tool designed to help developers efficiently debug, test, and manage API documentation."),(0,r.yg)("iframe",{width:"640",height:"360",src:"https://www.youtube.com/embed/TUWkcPKrhQs?si=00Iv7M4YqllPdIoQ",title:"YouTube video player",frameborder:"0",allow:"accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share",referrerpolicy:"strict-origin-when-cross-origin",allowfullscreen:!0}),(0,r.yg)("blockquote",null,(0,r.yg)("p",{parentName:"blockquote"},(0,r.yg)("strong",{parentName:"p"},"Who it's for")),(0,r.yg)("p",{parentName:"blockquote"},"This plugin is perfect for developers, testers, and anyone who needs to interact with APIs. Whether you're a beginner or a seasoned pro, you'll find it useful.")),(0,r.yg)("h2",{id:"1-key-features"},"1. Key Features"),(0,r.yg)("table",null,(0,r.yg)("thead",{parentName:"table"},(0,r.yg)("tr",{parentName:"thead"},(0,r.yg)("th",{parentName:"tr",align:null},"Feature"),(0,r.yg)("th",{parentName:"tr",align:null},"Description"))),(0,r.yg)("tbody",{parentName:"table"},(0,r.yg)("tr",{parentName:"tbody"},(0,r.yg)("td",{parentName:"tr",align:null},(0,r.yg)("strong",{parentName:"td"},"API Debugging")),(0,r.yg)("td",{parentName:"tr",align:null},"Supports HTTP/1.1, HTTP/2, SSE, WebSocket, Socket.IO, and GraphQL.")),(0,r.yg)("tr",{parentName:"tbody"},(0,r.yg)("td",{parentName:"tr",align:null},(0,r.yg)("strong",{parentName:"td"},"Automated Testing")),(0,r.yg)("td",{parentName:"tr",align:null},"Allows you to run bulk API tests in a directory format.")),(0,r.yg)("tr",{parentName:"tbody"},(0,r.yg)("td",{parentName:"tr",align:null},(0,r.yg)("strong",{parentName:"td"},"API Design & Docs")),(0,r.yg)("td",{parentName:"tr",align:null},"Lets you design APIs and automatically generate documentation for output and sharing.")),(0,r.yg)("tr",{parentName:"tbody"},(0,r.yg)("td",{parentName:"tr",align:null},(0,r.yg)("strong",{parentName:"td"},"Team Collaboration")),(0,r.yg)("td",{parentName:"tr",align:null},"Enables team collaboration with multi-device syncing.")),(0,r.yg)("tr",{parentName:"tbody"},(0,r.yg)("td",{parentName:"tr",align:null},(0,r.yg)("strong",{parentName:"td"},"Offline Support")),(0,r.yg)("td",{parentName:"tr",align:null},"No login required, ensuring data privacy with all info stored locally.")))),(0,r.yg)("hr",null),(0,r.yg)("h2",{id:"2-installation--setup"},"2. Installation & Setup"),(0,r.yg)("h3",{id:"installation-steps"},"Installation Steps"),(0,r.yg)("ol",null,(0,r.yg)("li",{parentName:"ol"},(0,r.yg)("p",{parentName:"li"},"Open ",(0,r.yg)("strong",{parentName:"p"},"VS Code"),".")),(0,r.yg)("li",{parentName:"ol"},(0,r.yg)("p",{parentName:"li"},'Go to the Extensions Marketplace: In the search bar, type "',(0,r.yg)("strong",{parentName:"p"},"EchoAPI for VS Code"),'", or just visit ',(0,r.yg)("a",{parentName:"p",href:"https://marketplace.visualstudio.com/items?itemName=EchoAPI.echoapi-for-vscode"},"the Marketplace link"),".\n",(0,r.yg)("img",{parentName:"p",src:"https://assets.echoapi.com/upload/user/216741487273459712/log/1ace4a5d-d0a7-42fa-9140-5194e558a47f.png",alt:"EchoAPI_Install.png",title:"EchoAPI_Install.png"}))),(0,r.yg)("li",{parentName:"ol"},(0,r.yg)("p",{parentName:"li"},"Once you find the plugin, click the ",(0,r.yg)("strong",{parentName:"p"},'"Install"')," button.")),(0,r.yg)("li",{parentName:"ol"},(0,r.yg)("p",{parentName:"li"},"Follow the on-screen instructions to complete the installation."))),(0,r.yg)("h3",{id:"verifying-installation"},"Verifying Installation"),(0,r.yg)("ul",null,(0,r.yg)("li",{parentName:"ul"},(0,r.yg)("p",{parentName:"li"},"Restart ",(0,r.yg)("strong",{parentName:"p"},"VS Code")," after the installation.")),(0,r.yg)("li",{parentName:"ul"},(0,r.yg)("p",{parentName:"li"},"Check the sidebar for the Extensions icon to make sure ",(0,r.yg)("strong",{parentName:"p"},"\u201cEchoAPI\u201d")," appears in your list.\n",(0,r.yg)("img",{parentName:"p",src:"https://assets.echoapi.com/upload/user/216741487273459712/log/ae3c95a3-d44b-495f-a46f-6591c0401a5c.png",alt:"EchoAPI_Install_VS Code.png",title:"EchoAPI_Install_VS Code.png"}))),(0,r.yg)("li",{parentName:"ul"},(0,r.yg)("p",{parentName:"li"},"If you don't see the extension, try manually refreshing the list or restart ",(0,r.yg)("strong",{parentName:"p"},"VS Code")," again."))),(0,r.yg)("blockquote",null,(0,r.yg)("p",{parentName:"blockquote"},(0,r.yg)("strong",{parentName:"p"},"Tip"),": If you run into issues during installation, check your network connection, make sure ",(0,r.yg)("strong",{parentName:"p"},"VS Code")," is up-to-date, or try reinstalling the plugin. You can manage the extension (disable, uninstall, or update) by clicking the gear icon next to it.")),(0,r.yg)("hr",null),(0,r.yg)("h2",{id:"3-user-login--account-management"},"3. User Login & Account Management"),(0,r.yg)("admonition",{type:"tip"},(0,r.yg)("mdxAdmonitionTitle",{parentName:"admonition"},"Note: You ",(0,r.yg)("strong",{parentName:"mdxAdmonitionTitle"},"don\u2019t need to log in")," to use EchoAPI. (If you don\u2019t need team collaboration, you can skip this part.)")),(0,r.yg)("h3",{id:"login-scenarios"},"Login Scenarios"),(0,r.yg)("table",null,(0,r.yg)("thead",{parentName:"table"},(0,r.yg)("tr",{parentName:"thead"},(0,r.yg)("th",{parentName:"tr",align:null},"Scenario"),(0,r.yg)("th",{parentName:"tr",align:null},"Description"))),(0,r.yg)("tbody",{parentName:"table"},(0,r.yg)("tr",{parentName:"tbody"},(0,r.yg)("td",{parentName:"tr",align:null},(0,r.yg)("strong",{parentName:"td"},"Team Collaboration")),(0,r.yg)("td",{parentName:"tr",align:null},"Switch between different cloud teams and projects.")),(0,r.yg)("tr",{parentName:"tbody"},(0,r.yg)("td",{parentName:"tr",align:null},(0,r.yg)("strong",{parentName:"td"},"Data Syncing")),(0,r.yg)("td",{parentName:"tr",align:null},"Pull or push data between local and cloud environments.")))),(0,r.yg)("h3",{id:"login-access"},"Login Access"),(0,r.yg)("ol",null,(0,r.yg)("li",{parentName:"ol"},(0,r.yg)("p",{parentName:"li"},"Click the ",(0,r.yg)("strong",{parentName:"p"},"\u201cMore\u201d")," button next to the product name and select ",(0,r.yg)("strong",{parentName:"p"},"\u201cManage Account\u201d")," to login .\n",(0,r.yg)("img",{parentName:"p",src:"https://assets.echoapi.com/upload/user/216741487273459712/log/c2d604f1-5620-4476-914d-7596293bce7a.png",alt:"EchoAPI_Manage_Account.png",title:"EchoAPI_Manage_Account.png"}))),(0,r.yg)("li",{parentName:"ol"},(0,r.yg)("p",{parentName:"li"},"Or, from the ",(0,r.yg)("strong",{parentName:"p"},"\u201cTeams\u201d")," dropdown, select ",(0,r.yg)("strong",{parentName:"p"},"\u201cSign in to EchoAPI\u201d")," to open the login page."))),(0,r.yg)("h3",{id:"login-steps"},"Login Steps"),(0,r.yg)("ol",null,(0,r.yg)("li",{parentName:"ol"},(0,r.yg)("p",{parentName:"li"},"On the login screen, click ",(0,r.yg)("strong",{parentName:"p"},"\u201cSign In\u201d"),".")),(0,r.yg)("li",{parentName:"ol"},(0,r.yg)("p",{parentName:"li"},"You'll be redirected to a web login page, where you can log in with ",(0,r.yg)("strong",{parentName:"p"},"Google"),", ",(0,r.yg)("strong",{parentName:"p"},"GitHub"),", or the ",(0,r.yg)("strong",{parentName:"p"},"email and password")," associated with your EchoAPI account..\n",(0,r.yg)("img",{parentName:"p",src:"https://assets.echoapi.com/upload/user/216741487273459712/log/db4a46d1-690e-4200-a994-13547f2f99df.png",alt:"EchoAPI_signin.png",title:"EchoAPI_signin.png"}))),(0,r.yg)("li",{parentName:"ol"},(0,r.yg)("p",{parentName:"li"},"Once you're logged in, the system will automatically return to ",(0,r.yg)("strong",{parentName:"p"},"VS Code"),"."))),(0,r.yg)("h3",{id:"logging-out"},"Logging Out"),(0,r.yg)("ol",null,(0,r.yg)("li",{parentName:"ol"},"On the login screen, click ",(0,r.yg)("strong",{parentName:"li"},"\u201cSign Out - Clear Data\u201d")," to log out.")),(0,r.yg)("hr",null),(0,r.yg)("h2",{id:"support--feedback"},"Support & Feedback"),(0,r.yg)("p",null,"If you encounter any issues or have suggestions, feel free to reach out to us through the following methods::"),(0,r.yg)("ul",null,(0,r.yg)("li",{parentName:"ul"},(0,r.yg)("strong",{parentName:"li"},"Technical Support Email"),": ",(0,r.yg)("a",{parentName:"li",href:"mailto:[email protected]"},"[email protected]")),(0,r.yg)("li",{parentName:"ul"},(0,r.yg)("strong",{parentName:"li"},"Online Feedback Form"),": ",(0,r.yg)("a",{parentName:"li",href:"https://docs.google.com/forms/d/e/1FAIpQLSd_xkxxnKgfh0GCMLXzHcKHcqT1cow2xXBXxGmqA-Z7GDyKkw/viewform?usp=pp_url"},"Feedback Form"))),(0,r.yg)("p",null,"We deeply value your feedback, as it contributes to the ongoing improvement of our product."))}u.isMDXComponent=!0}}]);