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

Эта статья участвовала в приказе о созыве Haowen, нажмите, чтобы просмотреть:Двойные заявки на внутреннюю и внешнюю стороны, призовой фонд в 20 000 юаней ждет вас, чтобы бросить вызов!

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

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

Введение в ЯПи

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

Прежде чем начать, вы можете сначала испытать это, испытать адрес:yapi.baidu.com

характеристика

Управление визуальным интерфейсом, основанный на функции редактирования интерфейса Websocket для совместной работы нескольких человек и инструменте тестирования, подобном Postman, что позволяет совместной работе нескольких человек удвоить эффективность разработки.
Права на плоский дизайн, что не только обеспечивает управление крупномасштабными проектами уровня предприятия, но и обеспечивает простоту использования.
автоматизированный тест, Полное автоматизированное тестирование интерфейсов, обеспечение правильности данных и поддержка утверждений в ответе.
Mock Server, простой в использовании фиктивный сервер, облегчающий генерацию фиктивных данных. В дополнение к поддержке обычных случайных макетов также добавлена функция ожидания Mock, и ожидаемые данные возвращаются в соответствии с установленными правилами фильтрации запросов.
Импорт и экспорт данных, поддерживает импорт Swagger, Postman,HARФормат данных, экспорт HTML, Markdown, формат данных JSON для облегчения переноса и архивирования документов интерфейса API.
Механизм плагина, мощный механизм подключаемых модулей, отвечающий различным потребностям бизнеса и облегчающий расширение и стыковку.
Основанный на JSON5 и Mockjs, интерфейс определяет структуру и документ возвращаемых данных, а эффективность многократно повышается.
Бесплатный и с открытым исходным кодом, поддержка вторичной разработки, развертывание интрасети, информационная безопасность и надежность.

кто использует

куда
Cтрип
Элонг
Мейтуан
Байду
Тенсент
Алибаба
Цзиндон
Сегодняшний заголовок
vip.com
Lianjia.com
быстрый работник
Удобная пчела
Китайские бизнесмены приносят пользу людям
Сина
VIPKID
осиное гнездо

Познакомьтесь с Япи

Прежде чем начать использовать YApi, давайте ознакомимся со структурой веб-сайта YApi, которая поможет вам быстро понять YApi.

Войти и зарегистрироваться:

Чтобы использовать YApi, вы должны сначала зарегистрировать учетную запись.

титульная страница:

После авторизации перейдите на домашнюю страницу, на которой отображаются группы и проекты.

В настоящее время у вас, как у нового пользователя, нет разрешений для групп и проектов, поэтому вы можете искать и просматривать только интерфейс «Общедоступных проектов». Если вы не можете найти какие-либо проекты на главной странице, обратитесь к администратору, чтобы добавить вас в соответствующий проект.

В шапке домашней страницы отображается текущее местоположение, окно поиска, новый проект, просмотр документов и информация о пользователе.
Информация о группе отображается в левой части главной страницы. «Группа» — это набор «проектов», и только суперадминистраторы могут управлять группами.
В правой части домашней страницы находится список проектов и участников группы.Нажмите на группу слева, и информация о проекте и участниках группы появится справа.
Нажмите на звездочку в правом верхнем углу проекта, чтобы подписаться на проект, и проект, на который вы подписаны, можно просмотреть на странице «Мои подписки».

Страница проекта:

Щелкните проект, чтобы перейти на страницу проекта.На странице проекта отображаются все интерфейсы, принадлежащие проекту, и представлены все операции проекта и интерфейса.

В настоящее время, как новый пользователь, вы можете только просматривать информацию об интерфейсе, но не можете редактировать проект или интерфейс.Если вам нужно отредактировать, свяжитесь с администратором, чтобы добавить вас в проект.

В «Списке интерфейсов» в левой части страницы проекта отображаются все интерфейсы проекта, а в правой части по умолчанию отображается список всех интерфейсов проекта.
Щелкните интерфейс слева, и справа появятся «Предварительный просмотр», «Редактировать» и «Выполнить».
Нажмите «Наборы тестов» слева, чтобы использовать функцию «Наборы тестов».
Нажмите вторичную навигацию «Настройки», лидер проекта может редактировать информацию о проекте и члены управления.
Нажмите «Динамический» во вторичной навигационной панели, чтобы просмотреть журнал операций проекта.

персональный центр:

Наведите указатель мыши на аватар пользователя или имя пользователя в правом верхнем углу, а затем нажмите «Личный центр», чтобы просмотреть личную информацию.

个人中心

На странице личной информации вы можете просмотреть и изменить свое имя пользователя, пароль и другую информацию.

个人设置

Руководство по эксплуатации Yapi

Прямая ссылкаОфициальный учебник.

развертывать

Приняв решение использовать YApi, первое, что нужно рассмотреть, — это способ развертывания. Хотя официал предоставляет подробные документы по развертыванию, но после одной операции я наступил на много ям, но я был в тупике. Здесь, в сочетании с официальным руководством по развертыванию, я предоставляю автономную установку YApi одним щелчком мыши на основе docker-compose, Kubernetes и других методов, которые более удобны.

Официальное руководство по развертыванию (рекомендуется визуальное развертывание)

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

Развертывание Docker онлайн/офлайн (личная рекомендация)

При условии сети развернуть напрямую через визуализацию (инструмент yapi-cli) очень просто, а при внутренней сети (без внешней сети) бессильно. Поэтому образ Docker специально создан для развертывания YApi одним щелчком мыши через docker-compose или Kubernetes.

зеркальное отображение

Эта часть в основном описывает процесс создания образа.docker hub, потяните его напрямую, не нужно делать зеркало самостоятельно.

config.json: файл конфигурации YApi, который можно изменить по мере необходимости и вставить в образ.

Commons.js: решить япипроблема с ошибкой.

Клонировать код этого проекта на локальный
```
git clone https://github.com/xcbeyond/deploy-scripts.git
```

построить образ

# 切换到 yapi 目录
cd yapi
# 需要花费一点时间
docker build -t xcbeyond/yapi:1.9.2 .

нажать изображение
```
docker push xcbeyond/yapi:1.9.2
```

Одностороннее развертывание

Поддерживает два способа развертывания с помощью Docker-Compose и Kubernetes.

Получение tar-пакета образа Docker

При наличии внешней сети эту операцию можно пропустить.

Если вы находитесь в автономном режиме (без внешней сети), вам необходимо заранее подготовить tar-пакет образа Docker.

В среде докера, которая может нормально подключаться к внешней сети, извлеките образxcbeyond/yapi.
```
docker pull xcbeyond/yapi:1.9.2
```
Сгенерируйте tar-архив образа докера.
```
docker save -o yapi-1.9.2.tar xcbeyond/yapi:1.9.2
```
Загрузите зеркальный tar-пакет yapi-1.9.2.tar в среду для развертывания.
Импортируйте архив изображений.
```
docker load < yapi-1.9.2.tar
```

развертывание с помощью docker-compose

Поместите файл docker-compose/yaip/docker-compose.yamlЗагрузите в среду развертывания и выполните команду docker-compose.docker-compose up -dРазвертывание завершено.

адрес доступа в браузереhttp://<部署环境IP>:3000, вы можете войти в систему как суперадминистратор или зарегистрировать новую учетную запись напрямую.

Супер администратор:admin@admin.com,ymfe.org, рекомендуется сменить пароль после входа в систему.

Развертывание Kubernetes

будетФайл ресурсов развертывания KubernetesЗагрузить в среду развертывания соответственно через командуkubectl apply -fзапускаемый файлmongodb.yamlиyapi.yamlРазвертывание завершено.

kubectl apply -f mongodb.yaml
# 等待 mongodb 启动成功后，再执行 yapi
kubectl apply -f yapi.yaml

Примечание. Сначала запустите mongodb, а затем запустите yapi.

адрес доступа в браузереhttp://<部署环境IP>:30300, вы можете войти в систему как суперадминистратор или зарегистрировать новую учетную запись напрямую.

Супер администратор:admin@admin.com,ymfe.org, рекомендуется сменить пароль после входа в систему.

Использованная литература:

hellosean1025.github.io/yapi/
GitHub.com/nextbeyond/…