開源可視化接口管理平台-YApi

yapi簡介：

YApi 是高效、易用、功能強大的 api 管理平台，旨在為開發、產品、測試人員提供更優雅的接口管理服務。可以幫助開發者輕松創建、發布、維護 API，YApi 還為用戶提供了優秀的交互體驗，開發人員只需利用平台提供的接口數據寫入工具以及簡單的點擊操作就可以實現接口的管理

特性

• 基於 Json5 和 Mockjs 定義接口返回數據的結構和文檔，效率提升多倍
• 扁平化權限設計，即保證了大型企業級項目的管理，又保證了易用性
• 類似 postman 的接口調試
• 自動化測試, 支持對 Response 斷言
• MockServer 除支持普通的隨機 mock 外，還增加了 Mock 期望功能，根據設置的請求過濾規則，返回期望數據
• 支持 postman, har, swagger 數據導入
• 免費開源，內網部署，信息再也不怕泄露了

使用

默認密碼是：ymfe.org，安裝成功后進入后台修改

可修改變量

環境變量	默認值	建議
VERSION	1.5.6	可以修改成yapi已發布的版本
HOME	/home	可修改
PORT	3000	可修改
ADMIN_EMAIL	[e-mail]	建議修改
DB_SERVER	mongo(127.0.0.1)	不建議修改
DB_NAME	yapi	不建議修改
DB_PORT	27017	不建議修改
VENDORS	${HOME}/vendors	不建議修改

獲取本鏡像

🚘獲取本鏡像：docker pull mrjin/yapi:latest

docker-compose 部署

[root@iZ1la3d1xbmukrZ ~]# cat docker-compose.yml
version: '2.1'
services:
  yapi:
    image: mrjin/yapi:latest
#    build: ./
    container_name: yapi
    environment:
      - VERSION=1.5.6
      - LOG_PATH=/tmp/yapi.log
      - HOME=/home
      - PORT=3000
      - ADMIN_EMAIL=[e-mail]
      - DB_SERVER=mongo
      - DB_NAME=yapi
      - DB_PORT=27017
    # restart: always
    ports:
      - 0.0.0.0:3000:3000
    volumes:
      - ~/data/yapi/log/yapi.log:/home/vendors/log # log dir
    depends_on:
      - mongo
    entrypoint: "bash /wait-for-it.sh mongo:27017 -- entrypoint.sh"
    networks:
      - back-net
  mongo:
    image: mongo
    container_name: mongo
    # restart: always
    ports:
      - 0.0.0.0:27017:27017
    volumes:
      - ~/data/yapi/mongodb:/data/db #db dir
    networks:
      - back-net
networks:
  back-net:
    external: true
[root@iZ1la3d1xbmukrZ ~]#

[root@iZ1la3d1xbmukrZ ~]# vim docker-compose.yml
[root@iZ1la3d1xbmukrZ ~]# docker network create back-net
3321b47739946e3314317fc7852c052aade186856ab18f48381251f3d055305d
[root@iZ1la3d1xbmukrZ ~]# docker-compose up -d
WARNING: The Docker Engine you're using is running in swarm mode.

Compose does not use swarm mode to deploy services to multiple nodes in a swarm. All containers will be scheduled on the current node.

To deploy your application across the swarm, use `docker stack deploy`.

Creating mongo ... done
Creating yapi  ... done
[root@iZ1la3d1xbmukrZ ~]# docker-compose ps
Name               Command               State            Ports
-------------------------------------------------------------------------
mongo   docker-entrypoint.sh mongod      Up      0.0.0.0:27017->27017/tcp
yapi    bash /wait-for-it.sh mongo ...   Up      0.0.0.0:3000->3000/tcp
[root@iZ1la3d1xbmukrZ ~]# lsof -i:3000
COMMAND     PID USER   FD   TYPE   DEVICE SIZE/OFF NODE NAME
docker-pr 27790 root    4u  IPv6 22077531      0t0  TCP *:hbci (LISTEN)

 想看如何使用的，建議去文檔看看，使用這個開源項目的，有很多大廠。

YApi 的一些客戶

• 去哪兒
• 攜程
• 藝龍
• 美團
• 百度
• 騰訊
• 阿里巴巴
• 京東
• 今日頭條
• 唯品支付
• 鏈家網
• 快手
• 便利蜂
• 中商惠民
• 新浪
• VIPKID
• 馬蜂

使用說明查看文檔：https://hellosean1025.github.io/yapi/

github地址：https://github.com/YMFE/yapi