эффективный инструмент документирования vscode-yapi-interface

JavaScript
эффективный инструмент документирования vscode-yapi-interface

Когда раньше был выпущен плагин vscode-yapi, он казался несколько поспешным и не было документации, что вызывало некоторое замешательство у пользователей, сейчас я дополнил документацию и реализовал большинство функций согласно своим прежним пожеланиям, просто делюсь. снова сегодня.

Прежде всего, я очень благодарен команде yapi за поддержку openapi, которая привела к появлению сегодня vscode-yapi. На самом деле сначала я просто хотел сделать плагин внутри компании, а потом подумал про себя, что раз он имеет свою ценность, то почему бы не сделать его плагином vscode-yapi и не опубликовать.

vscode-yapiосновывается наvscode extension + yapi openapiРазработал эффективный инструмент документирования интерфейсов**. **

vscode-yapiУсловия установки**: "vscode": "^1.44.0" , "yapi": "^1.5.6"**

vscode-yapiАдрес документа:lisiyizu.github.io

документация vscode-yapi:lisiyizu.github.io

Цель разработки vscode-yapi:

  • Унифицируйте спецификацию, определенную фронтенд-командой в интерфейсе
  • Улучшить ремонтопригодность документации интерфейса
  • Повышение эффективности документов интерфейса стыковки интерфейсной группы.

Функции vscode-yapi следующие:

  • Настройки плагина:yapi配置,主题设置,项目token管理
  • Настройки шаблона:参数模板,api模板
  • Документация по интерфейсу:光标定位接口,右键直接查看接口文档
  • центр управления:跨项目的去勾选,快速生成api模板定义
  • Быстро сгенерируйте код шаблона:快速直接生成模板代码
  • Интерфейс предварительного просмотра при наведении: выделение (выбрано) + наведение (наведение мыши) Функция интерфейса предварительного просмотра при наведении

Интерфейс функции vscode-yapi выглядит следующим образом:

Интерфейс настроек плагина

Интерфейс настройки шаблона

интерфейс документация интерфейс

Интерфейс центра управления

Демонстрация операции быстрого создания кода шаблона GIF

Плавающая функция предварительного просмотра интерфейса

На момент скачивания установил 2020-08-22 21:30604Посещения, последняя версия обновлена ​​доv1.2.4охватывать

Разработка плагинов не приносит денег,Это все о том, чтобы подружиться!

При фронтальной разработке время отладки интерфейса занимает большую часть нашего времени, когда мы думаем о переключении документов интерфейса между браузером и IDE. Такой опыт вызывает у меня некоторую боль.Во-первых, это пустая трата времени и влияет на эффективность работы.Во-вторых, все, что я делаю, это копирую и вставляю туда-сюда. Это состояние делает меня таким ** «ленивым»Возник вопрос, можно ли разработать плагин vscode-yapi для решения этой проблемы. В начале я понятия не имел и не знал, с чего начать разработку плагина vscode, и я не был уверен, что это можно сделать. Сказав это, спасибоРанняя утренняя чат-конференция**, и в то же время я хотел бы поблагодарить одного человека — гостя, который участвовал во второй фазе раннего чата, отАлимама@Чунчжи. Меня больше впечатлило то, чем он поделился, он поделился тем, что разработала его команда.vscode-magixПлагин и открытый исходный код (GitHub.com/thx/vscode-…). vscode-magix стал наставником и маяком vscode-yapi. Студентам, у которых есть идеи по разработке или изучению плагинов vscode, рекомендуется обращаться к проекту vscode-magix.

Не принимайте близко к сердцу: Если платформа управления интерфейсом вашей компании использует yapi, а ваша фронтенд-команда использует vscode IDE, вы также можете попробовать этот плагин.

Я надеюсь, что больше людей с идеями смогут присоединиться к его поддержке в будущем.В конце концов, идеи одного человека ограничены. Если у вас есть идеи или предложения по плагину vscode-yapi.

Добро пожаловать в группу общения, [vscode-yapi-группа связи] Номер группы QQ:1065561413 

Если вы думаете, что это нормально, добро пожаловатьНравится 👍👍👍****Поддержите, оставьте комментарий.

Автор ждет возможности трудоустройства.Я нахожусь в Пекине, и я приветствую рекомендации.