YApi имеет следующие характеристики:

• Предварительный интерфейс управления: YApi предоставляет интерфейс предварительного просмотра интерфейса, который можно легко создать.、Редактируйте и просматривайте интерфейсные документы.
• интерфейсMock：YApiможет быть основано наинтерфейсдокумент自动生成Ложные данные,Удобен для отладки интерфейсным и серверным разработчикам.
• Тест интерфейса: YApi предоставляет функцию тестирования интерфейса, с помощью которой можно легко протестировать интерфейс и просмотреть результаты тестирования.
• Совместная работа в команде: YApi поддерживает совместную работу в команде.,Можно создать несколько команд,И предоставьте разрешения на интерфейс управления документом.
• Импорт и экспорт: YApi поддерживает импорт и экспорт интерфейсных документов.,Облегчает миграцию и обмен интерфейсными документами между различными средами.

Официальный сайт:

https://github.com/YMFE/yapi

Установка и развертывание

Для развертывания YApi вы можете использовать официально предоставленный образ Docker или развернуть его вручную. Вот краткие шаги по развертыванию YApi вручную:

1. Загрузите исходный код YApi. Вы можете скачать последнюю версию исходного кода из репозитория YApi на GitHub.

2. Установите Node.js и MongoDB. YApi использует Node.js и MongoDB, поэтому сначала вам необходимо установить эти два программного обеспечения.

3. Установите зависимости YApi. В каталоге исходного кода YApi выполните следующую команду, чтобы установить зависимости YApi:

npm install --production --registry https://registry.npm.taobao.org

4. Настройте YApi. В каталоге исходного кода YApi скопируйте файл config_example.json и переименуйте его в config.json, а затем настройте файл config.json в соответствии с реальной ситуацией, включая информацию о подключении MongoDB, конфигурацию электронной почты и т. д.

5. Запустите YApi. В каталоге исходного кода YApi выполните следующую команду, чтобы запустить YApi:

node server/app.js

6. Доступ к YApi: откройте http://localhost:3000 в браузере, чтобы войти в интерфейс управления YApi.

Выше приведены краткие инструкции по развертыванию YApi вручную. Фактический процесс развертывания может варьироваться в зависимости от конкретной ситуации. В реальных производственных средах для развертывания рекомендуется использовать Docker, чтобы упростить процесс развертывания и управления.

Чтобы развернуть YApi с помощью Docker, вы можете выполнить следующие шаги:

1. Установите Docker и Docker Compose: Если Docker и Docker Compose не установлены на вашем компьютере, вы можете установить их согласно инструкциям в официальной документации.
2. Создайте файл YApi Docker Compose. В новом каталоге создайте файл с именем docker-compose.yml и добавьте следующий контент:

version: '3'
services:
  yapi:
    image: 'ymyzk/yapi'
    container_name: yapi
    ports:
      - '3000:3000'
    environment:
      - TZ=Asia/Shanghai
    volumes:
      - ./config.json:/app/config.json
    networks:
      - yapi-net
    depends_on:
      - mongo
  mongo:
    image: 'mongo:3.4'
    container_name: yapi-mongo
    ports:
      - '27017:27017'
    volumes:
      - ./mongo_data:/data/db
    networks:
      - yapi-net
networks:
  yapi-net:
    driver: bridge

В этом файле Docker Compose мы определяем две службы: yapi и mongo. Служба yapi использует официальный образ YApi Docker, а служба mongo — официальный образ MongoDB. Мы подключили файл конфигурации YApi config.json к сервису yapi, чтобы настроить параметры YApi.

1. Создайте файл конфигурации YApi. Создайте файл конфигурации с именем config.json в том же каталоге, что и файл docker-compose.yml, и настройте параметры YApi в соответствии с реальной ситуацией, например информацию о подключении MongoDB, конфигурацию электронной почты и т. д.
2. Запустите YApi: в каталоге, содержащем файл docker-compose.yml и файл config.json, выполните следующую команду, чтобы запустить YApi:

docker-compose up -d

Это запустит Docker-контейнеры YApi и MongoDB и запустит их в фоновом режиме.

1. Доступ к YApi: посетите http://localhost:3000 в браузере, чтобы войти в интерфейс управления YApi.

Выполнив описанные выше шаги, вы можете использовать Docker для быстрого развертывания YApi и начать управлять документами интерфейса API и делиться ими.

Если вы не хотите создавать его локально, вы также можете напрямую посетить официальный сайт:

http://yapi.mglicai.com/

Если вы считаете это полезным, пожалуйста, подпишитесь и поставьте лайк!