Awesome

YApi-X

YApi-X 基于 YApi v1.8.8 开发，相较原版，有以下改动：

• 接口路径支持更多字符，可以将 @、#、; 等字符用于接口路径定义；
• 支持复制分类；
• 新增 adminPassword 配置项以设置管理员密码；
• 项目图标支持自传图片；
• 接口运行支持上传文件（需安装插件 →）；
• 请求参数设置下的 Headers 支持批量添加；
• 支持 webdav 扩展的 HTTP 请求方法 PROPFIND, PROPPATCH, MKCOL, COPY, MOVE, LOCK, UNLOCK（了解更多 →）；
• 支持为路径参数、查询参数设置类型。

• 如何安装
  • YApi-X 镜像
  • 通过 Docker Compose 安装
    • 运行
    • 重启
    • 升级
    • 迁移
    • 日志
• 如何配置
  • 基础配置
  • 数据库配置
  • 邮件配置
  • LDAP 登录配置
  • 插件配置

如何安装

为了节省各自的时间，推荐你使用 Docker 安装，同时本文档也不会介绍其他安装方式。

YApi-X 镜像

• Docker Hub: https://hub.docker.com/r/jayfong/yapi-x/tags

通过 Docker Compose 安装

以下是一个示例：

version: '3'

services:
  yapi-web:
    image: jayfong/yapi-x:latest
    container_name: yapi-web
    ports:
      - 40001:3000
    environment:
      - YAPI_ADMIN_ACCOUNT=admin@docker.yapi
      - YAPI_ADMIN_PASSWORD=adm1n
      - YAPI_CLOSE_REGISTER=true
      - YAPI_DB_SERVERNAME=yapi-mongo
      - YAPI_DB_PORT=27017
      - YAPI_DB_DATABASE=yapi
      - YAPI_MAIL_ENABLE=false
      - YAPI_LDAP_LOGIN_ENABLE=false
      - YAPI_PLUGINS=[]
    depends_on:
      - yapi-mongo
    links:
      - yapi-mongo
    restart: unless-stopped
  yapi-mongo:
    image: mongo:latest
    container_name: yapi-mongo
    volumes:
      - ./data/db:/data/db
    expose:
      - 27017
    restart: unless-stopped

运行

将上面的示例复制粘贴下来命名为 docker-compose.yml，使用以下命令运行：

docker-compose up -d

然后，通过 http://localhost:40001 即可访问 YApi-X。

重启

若你修改了配置，务必重启应用才能生效：

docker-compose restart yapi-web

升级

YApi-X 一旦有更新，你可通过以下命令升级：

docker-compose pull yapi-web \
  && docker-compose down \
  && docker-compose up -d

升级不会对原有数据造成任何影响！

迁移

直接打包整个目录去新的服务器即可。

日志

如果出现意外情况，你可通过以下命令查看运行日志：

docker-compose logs yapi-web

如何配置

你可通过环境变量进行配置。

基础配置

数据库配置

邮件配置

LDAP 登录配置

插件配置