Автоматически обновлять данные интерфейса Swagger до платформы YApi

Node.js внешний интерфейс Командная строка Swagger

Этот учебник в основном знакомит с автоматическим обновлениемSwaggerданные дляYApi 接口管理平台, мы предполагаем, что вы уже умеете пользоватьсяПлатформа управления интерфейсом YApi.

Среда конфигурации

yapi-cli зависит от Node.js, установите Node.js версии 7.6 или выше.Если на вашем компьютере установлен инструмент yapi-cli и номер версии >= 2.7, вы можете игнорировать этот раздел.

Установите Node.js

Вариант 1: изNode.jsСкачайте установочный пакет с официального сайта

Вариант 2: использоватьNode Version Manager(NVM)Чтобы установить Node.js, вы можете установить NVM с помощью следующей команды:

cURL:

$ curl -o- https://raw.githubusercontent.com/creationix/nvm/v0.33.2/install.sh | bash

Wget:

$ wget -qO- https://raw.githubusercontent.com/creationix/nvm/v0.33.2/install.sh | bash

После установки NVM перезапустите терминал и выполните следующую команду для установки Node.js:

nvm install stable

Установите yapi-cli с помощью NPM

Убедитесь, что версия инструмента yapi-cli >= 1.2.7.

npm install yapi-cli [-g]

инструкции

Эту функцию можно использовать на любой машине, просто убедитесь, что машина может подключиться к развернутому веб-сайту YApi.

Шаг 1: Создайте новый файл конфигурации

Создайте новый файл конфигурации в любом каталогеyapi-import.json, содержание следующее:

{
  "type": "swagger",
  "token": "17fba0027f300248b804",
  "file": "swagger.json",
  "merge": "good",
  "server": "http://yapi.local.qunar.com:3000"
}

typeЭто метод данных данных.В настоящее время официально поддерживается только swagger.

tokenэто токен проекта, в项目设置 -> tokenустановить получить

fileЯвляется ли файл документации интерфейса swagger, может использовать абсолютный путь или URL-адрес

mergeИмпортируйте старую стратегию интерфейса и используйте интеллектуальный режим по умолчанию.Существует три режима: «нормальный» (нормальный режим), «хороший» (интеллектуальное слияние), «слияние» (полное покрытие).

serverэто адрес сервера япи

Второй шаг — выполнить команду импорта

существует新建配置文件的当前目录, выполните следующую команду, чтобы импортировать данные в платформу управления интерфейсом yapi.

yapi import

Если подсказку не удается найтиyapiкоманду, попробуйте выполнитьyapi-cli, так как некоторые системные среды несовместимы.

автоматическое обновление

С помощью crontab и других инструментов для выполнения задач по времени вы можете автоматически обновлять данные интерфейса, и я считаю, что вы можете делать это с умом.

Категории