1 В избранное 0 Ответвления 0

OSCHINA-MIRROR/suxiaoxin123-yapi

Присоединиться к Gitlife
Откройте для себя и примите участие в публичных проектах с открытым исходным кодом с участием более 10 миллионов разработчиков. Приватные репозитории также полностью бесплатны :)
Присоединиться бесплатно
Клонировать/Скачать
Внести вклад в разработку кода
Синхронизировать код
Отмена
Подсказка: Поскольку Git не поддерживает пустые директории, создание директории приведёт к созданию пустого файла .keep.
Loading...
README.md

YApi визуальная платформа управления API

Ссылка для тестирования:

http://yapi.smart-xwork.cn/

Документация:

hellosean1025.github.io/yapi

Описание платформы

avatar

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

Группы для общения в QQ:

644642474 основная группа может быть заполнена

941802405 вторая группа приветствует новых участников### Основные характеристики

  • Определение структуры и документация ответов API с помощью JSON5 и Mockjs повышает эффективность многократно
  • Упрощенная модель управления правами доступа обеспечивает управление крупномасштабными проектами и удобство использования
  • Аналогичная возможность отладки API как в Postman
  • Автоматическое тестирование, поддерживающее проверку ответов
  • Сервер MockServer поддерживает обычное случайное моделирование и расширенную функцию ожидаемого ответа, которая возвращает ожидаемые данные в соответствии с установленными правилами фильтрации запросов
  • Поддержка импорта данных из Postman, HAR и Swagger
  • Бесплатная открытая лицензия, внутренняя установка, информация больше не будет утекать### Внутреннее развертывание

Требования к среде

  • NodeJS (7.6+)
  • MongoDB (2.6+)
  • Git

Установка

Используйте нашу команду yapi-cli для легкого развертывания YApi. Выполните yapi server для запуска визуального процесса развертывания, введите соответствующие конфигурации и нажмите кнопку «начать», чтобы завершить развертывание всего сайта. После завершения развертывания выполните node/{путь_до_сайта}/server/app.js для запуска сервера. Откройте браузер и перейдите по указанному URL, затем войдите, используя электронную почту администратора, которую вы указали при настройке, а пароль по умолчанию — ymfe.org (по умолчанию можно изменить пароль в личном центре).

npm install -g yapi-cli --registry https://registry.npm.taobao.org
yapi server 

Управление сервисом

Используйте pm2 для удобного управления сервисом.

npm install pm2 -g  # установка pm2
cd {путь_до_проекта}
pm2 start "vendors/server/app.js" --name yapi # управление сервисом yapi через pm2
pm2 info yapi # просмотр информации о сервисе
pm2 stop yapi # остановка сервиса
pm2 restart yapi # перезапуск сервиса

Обновление

Обновление версии проекта очень простое и не влияет на существующие данные проекта, а лишь синхронизирует исходные файлы в директории vendors.

cd {путь_к_проекту}
yapi ls # просмотреть список версий
yapi update # обновиться до последней версии
yapi update -v {версия} # обновиться до указанной версии
```### Учебные материалы
* [Управление документацией API, тестирование и мокинг с помощью YApi](https://juejin.im/post/5acc879f6fb9a028c42e8822)
* [Автоматическое обновление данных Swagger-интерфейсов на платформе YApi](https://juejin.im/post/5af500e251882567096140dd)
* [Автоматизация тестирования](https://juejin.im/post/5a388892f265da430e4f4681)
* [Практика повышения производительности разработки API с использованием GTest (на основе YApi)](https://mp.weixin.qq.com/s/z66f7bRX8aAOppAtBIB7Uw)

### Плагины YApi
* [плагин yapi sso входа](https://github.com/YMFE/yapi-plugin-qsso)
* [плагин yapi cas входа](https://github.com/wsfe/yapi-plugin-cas) от wsfe
* [плагин yapi gitlab интеграции](https://github.com/cyj0122/yapi-plugin-gitlab)
* [плагин oauth2.0 входа](https://github.com/xwxsee2014/yapi-plugin-oauth2)
* [плагин импорта данных платформы rap](https://github.com/wxxcarl/yapi-plugin-import-rap)
* [плагин dingding](https://github.com/zgs225/yapi-plugin-dding) плагин отправки сообщений через бота DingDing
* [плагин export-docx-data](https://github.com/inceptiongt/Yapi-plugin-export-docx-data) плагин экспорта данных в docx документ
* [плагин interface-oauth-token](https://github.com/shouldnotappearcalm/yapi-plugin-interface-oauth2-token) плагин автоматического получения токена авторизации
* [плагин import-swagger-customize](https://github.com/follow-my-heart/yapi-plugin-import-swagger-customize) плагин импорта специфических swagger интерфейсов### Генерация кода
* [yapi-to-typescript: генерация TypeScript запросов на основе определений API в YApi](https://github.com/fjc0k/yapi-to-typescript)
* [yapi-gen-js-code: генерация JavaScript запросов на основе определений API в YApi](https://github.com/hellosean1025/yapi-gen-js-code)
* [SwiftJSONModeler: генерация кода моделей Swift на основе определений API в YApi](https://github.com/CodeOcenS/SwiftJSONModeler)

### Деплой YApi с помощью Docker (неофициальная версия)
* [Использование Alpine-версии Docker-образа для быстрого деплоя YApi](https://www.jianshu.com/p/a97d2efb23c5)
* [docker-yapi: решение на основе официального yapi-cli с использованием docker-compose](https://github.com/Ryan-Miao/docker-yapi)
* [docker-compose для однокнопочного деплоя YApi](https://github.com/jinfeijie/yapi)
* [docker-YApi: более удобный образ YApi](https://github.com/fjc0k/docker-YApi)
* [Использование DockerCompose для сборки и деплоя YApi](https://github.com/MyHerux/daily-code/blob/master/Program/%D0%9F%D1%80%D0%BE%D0%B3%D1%80%D0%B0%D0%BC%D1%8B/Yapi/%D0%98%D1%81%D0%BF%D0%BE%D0%BB%D1%8C%D0%BD%D0%B8%D0%B5DockerCompose%D0%B4%D0%BB%D1%8F%D1%8F%D1%81%D0%B8%D0%B1%D1%80%D0%BE%D0%B2%D0%BA%D0%B8.md)
* [yapi-docker: всё в одном для деплоя YApi с помощью Docker](https://github.com/williamlsh/yapi-docker)

### Некоторые инструменты для YApi
* [Генератор API](https://github.com/Forgus/api-generator) — автоматический генератор документации для API (без вторжения в код)
* [Инструмент HTTP для MySQL, который можно использовать для автоматизированного тестирования](https://github.com/hellosean1025/http-mysql-server)
* [Плагин IDEA для быстрого загрузки API в YApi](https://github.com/diwand/YapiIdeaUploadPlugin)
* [Плагин IDEA для загрузки и отладки API easy-yapi](https://easyyapi.com/)
* [Сервис выполнения SQL запросов для PostgreSQL](https://github.com/shouldnotappearcalm/http-postgres-server)* [Автоматическое создание документации YApi для SpringBoot](https://github.com/NoBugBoy/YDoc)
* [YapiX Генерация документации API, загрузка в YApi, Rap2, Eolinker и т. д. (плагин для IDEA)](https://github.com/jetplugins/yapix)### Некоторые клиенты YApi
* Qunar
* Ctrip
* Elong
* Meituan
* Baidu
* Tencent
* Alibaba
* JD
* Toutiao
* VipPay
* Lianjia
* Kuaishou
* FudiFeng
* ZhongshangHuiMin
* Sina
* VIPKid
* Mafengwo
* ByteDance
* BianYu

### Авторы
* [hellosean1025](https://github.com/hellosean1025)
* [gaoxiaomumu](https://github.com/gaoxiaomumu)
* [zwjamnsss](https://github.com/amnsss)
* [dwb1994](https://github.com/dwb1994)
* [fungezi](https://github.com/fungezi)
* [ariesly15](https://github.com/ariesly15)

### Лицензия
Лицензия Apache 2.0

Комментарии ( 0 )

Вы можете оставить комментарий после Вход в систему

Введение

Визуализация интерфейса управления платформой. Развернуть Свернуть
Apache-2.0
Отмена

Обновления

Пока нет обновлений

Участники

все

Недавние действия

Загрузить больше
Больше нет результатов для загрузки
1
https://api.gitlife.ru/oschina-mirror/suxiaoxin123-yapi.git
git@api.gitlife.ru:oschina-mirror/suxiaoxin123-yapi.git
oschina-mirror
suxiaoxin123-yapi
suxiaoxin123-yapi
master