When the VScode-yAPI plug-in was released before, it was a little hasty and there were no documents, which caused some confusion to users. Now I have made up the documents and realized most functions according to my previous wishes. Today I would like to share it again.

First of all, I would like to thank the YAPI team for their support of OpenAPI, which led to the emergence of VScode-YAPI today. In fact, I just wanted to make it into an internal plug-in, and then I was working on it and I thought if it’s worth it, why not publish it as a VS code-y API plug-in.

Vscode – YAPI is based on vscode extension + yAPI openAPI developed by an efficient interface document tool **. **

Vscode – yapi installation condition * * : “vscode” : “^ 1.44.0”, “yapi” : “^ 1.5.6” * *

Vscode-yapi documentation address: lisiyizu.github. IO

Vscode-yapi documentation: lisiyizu.github. IO

The purpose of developing VS code-yAPI:

  • Unify the front-end team’s specification on interface definition
  • Improve the maintainability of interface documentation
  • Improve the efficiency of the front-end team’s interface documentation

Vscode-yapi has the following functions:

  • Plug-in Settings:Yapi configuration,Theme Settings,Project Token Management
  • Template Settings:Parameters of the template,API template
  • Interface documentation:Locate the interface with the cursor and right-click to view the interface document
  • Management Center:Uncheck across projects to quickly generate API template definitions
  • Quickly generate template code:Generate template code quickly and directly
  • Hover preview interface: Selection (select) + Hover (mouse row) hover preview interface function

Vscode-yapi function interface is as follows:

Plug-in setup interface

Template Setting page

Interface document interface

Management Center Interface

Quick generate template code operation demo GIF

Floating interface preview function

As of 2020-08-22 21:30, 604 people have been downloaded. The latest version has been updated to V1.2.4

You don’t make money developing plugins, it’s all about making friends!

For front-end development, interface syndication takes up most of our time, when we think of the interface documentation we toggle back and forth from the browser to the IDE. This kind of experience makes me feel a little painful. Firstly, it is a waste of time and affects work efficiency. Secondly, all I do is copy and paste back and forth. This makes me a ** lazy person wondering if I could develop a VS code-y API plug-in to solve this problem. At the beginning, I did not know how to develop a vscode plug-in, and I was not sure that this thing could be done. Speaking of which, I would like to thank the early chat conference **, but also to thank a person, he is the second share of the early chat guest, from Ali mom @Chongzhi. I was more impressed by what he shared. He shared the VS code-Magix plugin developed by his team and made it open source (github.com/thx/vscode-…). . Vscode-magix became a mentor and beacon for VScode-YAPI. The vscode-magix project is recommended for those who want to develop or learn vscode plug-ins.

Amway: if your company uses yapi for its interface management platform and your front-end team also uses vscode IDE, try this plug-in.

I hope that more people with ideas can join us to maintain it. After all, a person’s ideas are limited. If you have any ideas or suggestions for vscode-y API plug-ins.

Welcome to group communication, [VScode – YAPI – communication communication group] QQ group number: 1065561413

If you think it is ok, please like 👍👍👍**** support, leave a comment.

I am looking for job opportunities, I am in Beijing, there is a pit welcome recommendation.