自建接口管理平台 -- YApi

参考 项目源码:GitHub - YMFE/yapi: YApi 是一个可本地部署的、打通前后端及QA的、可视化的接口管理平台 部署文档:内网部署 博客教程:使用 docker-compose 部署和使用 Yapi_docker-compose运行yapi-CSDN博客 第三方Docker项目源码:

参考

项目源码:GitHub - YMFE/yapi: YApi 是一个可本地部署的、打通前后端及QA的、可视化的接口管理平台

部署文档:内网部署

博客教程:使用 docker-compose 部署和使用 Yapi_docker-compose运行yapi-CSDN博客

第三方Docker项目源码:GitHub - fjc0k/docker-YApi: 接口管理平台 YApi 的 Docker 镜像。

部署流程

直接使用docker compose 一键部署所需的数据库和yapi

services:
  mongodb:
    container_name: mongodb
    image: mongo:latest
    restart: always
    ports:
      - 27017:27017
    environment:
      - MONGO_INITDB_ROOT_USERNAME=yapi # 你的数据库用户名
      - MONGO_INITDB_ROOT_PASSWORD=yapi # 你的数据库密码
    volumes:
      - ./mongodb_data:/data/db
    networks:
      - yapi
    # 增加启动参数,--auth,表示连接 mongodb 需要用户名和密码
    command:
      - "--auth"

  yapi:
    image: jayfong/yapi:latest
    container_name: yapi
    restart: always
    ports:
      - 3000:3000
    environment:
      # 随便设置一个账号(账号是邮箱的格式)
      - YAPI_ADMIN_ACCOUNT=yapi@yapi.com
      # 设置账号的密码
      - YAPI_ADMIN_PASSWORD=yapi # 你的账号密码
      # 禁用注册功能
      - YAPI_CLOSE_REGISTER=true
      # 设置连接 mongdb 的服务器地址,可以使用容器内部的 mongodb 服务名称
      - YAPI_DB_SERVERNAME=mongodb
      - YAPI_DB_PORT=27017
      - YAPI_DB_DATABASE=yapidb # 数据库名,自定义即可,无需提前创建,会自动创建
      - YAPI_DB_USER=yapi # 你的数据库用户名
      - YAPI_DB_PASS=yapi # 你的数据库密码
      - YAPI_DB_AUTH_SOURCE=admin
      #- YAPI_DB_CONNECT_STRING="mongodb://yapi:yapi@mongodb:27017/yapidb?authSource=admin"
      # 禁用发送邮件的功能
      - YAPI_MAIL_ENABLE=false
      # 禁用 LDAP 登录功能
      - YAPI_LDAP_LOGIN_ENABLE=false
      # 不使用任何插件
      - YAPI_PLUGINS=[]
    networks:
      - yapi
    depends_on:
      - mongodb

networks:
  yapi:
    name: yapi

效果演示

image.png

image.png

Comment