开源可视化接口管理平台-YApi

2022-05-31 17:05:01

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	me@jinfeijie.cn	建议修改
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=me@jinfeijie.cn
      - 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)