- Notifications
You must be signed in to change notification settings - Fork43
fjc0k/YApi-X
Folders and files
| Name | Name | Last commit message | Last commit date | |
|---|---|---|---|---|
Repository files navigation
YApi-X 基于YApi v1.8.8 开发，相较原版，有以下改动：
- 接口路径支持更多字符，可以将
@、#、;等字符用于接口路径定义； - 支持复制分类；
- 新增
adminPassword配置项以设置管理员密码； - 项目图标支持自传图片；
- 接口运行支持上传文件（需安装插件 →）；
- 请求参数设置下的 Headers 支持批量添加；
- 支持 webdav 扩展的 HTTP 请求方法 PROPFIND, PROPPATCH, MKCOL, COPY, MOVE, LOCK, UNLOCK（了解更多 →）；
- 支持为路径参数、查询参数设置类型。
为了节省各自的时间，推荐你使用Docker 安装，同时本文档也不会介绍其他安装方式。
- Docker Hub:https://hub.docker.com/r/jayfong/yapi-x/tags
以下是一个示例：
version:'3'services:yapi-web:image:jayfong/yapi-x:latestcontainer_name:yapi-webports: -40001:3000environment: -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-mongolinks: -yapi-mongorestart:unless-stoppedyapi-mongo:image:mongo:latestcontainer_name:yapi-mongovolumes: -./data/db:/data/dbexpose: -27017restart: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
你可通过环境变量进行配置。
| 环境变量名称 | 类型 | 说明 | 示例 |
|---|---|---|---|
| YAPI_ADMIN_ACCOUNT | string | 管理员账号（邮箱） | admin@foo.bar |
| YAPI_ADMIN_PASSWORD | string | 管理员密码 | adm1n |
| YAPI_CLOSE_REGISTER | boolean | 是否关闭注册 | true |
| 环境变量名称 | 类型 | 说明 | 示例 |
|---|---|---|---|
| YAPI_DB_SERVERNAME | string | MongoDB 服务地址 | yapi-mongo |
| YAPI_DB_PORT | number | MongoDB 服务端口 | 27017 |
| YAPI_DB_DATABASE | string | 使用的 MongoDB 数据库 | yapi |
| YAPI_DB_USER | string | 登录 MongoDB 服务的用户名 | root |
| YAPI_DB_PASS | string | 登录 MongoDB 服务的用户密码 | r00t |
| YAPI_DB_AUTH_SOURCE | string | MongoDB 身份认证所用库 | admin |
| YAPI_DB_CONNECT_STRING | string | 使用 MongoDB 集群时配置 | mongodb://127.0.0.100:8418,127.0.0.101:8418/yapidb?slaveOk=true |
| YAPI_DB_OPTIONS | json | Mongoose 连接 MongoDB 服务时的额外选项，一般不用设置。请参考:Mongoose.prototype.connect() | {} |
| 环境变量名称 | 类型 | 说明 | 示例 |
|---|---|---|---|
| YAPI_MAIL_ENABLE | boolean | 是否启用 | true |
| YAPI_MAIL_HOST | string | 邮件服务地址 | smtp.163.com |
| YAPI_MAIL_PORT | number | 邮件服务端口 | 465 |
| YAPI_MAIL_FROM | string | 发送人邮箱 | foo@163.com |
| YAPI_MAIL_AUTH_USER | string | 登录邮件服务的用户名 | bar@163.com |
| YAPI_MAIL_AUTH_PASS | string | 登录邮件服务的用户密码 | f00bar |
| YAPI_MAIL_OPTIONS | json | 传递给 Nodemailer 的额外选项，一般不用设置。请参考：Nodemailer > SMTP transport | {"tls":{"rejectUnauthorized":false}} |
| 环境变量名称 | 类型 | 说明 | 示例 |
|---|---|---|---|
| YAPI_LDAP_LOGIN_ENABLE | boolean | 是否启用 | true |
| YAPI_LDAP_LOGIN_SERVER | string | LDAP 服务地址 | ldap://ldap.foo.bar |
| YAPI_LDAP_LOGIN_BASE_DN | string | 登录 LDAP 服务的用户名 | cn=admin,dc=foo,dc=bar |
| YAPI_LDAP_LOGIN_BIND_PASSWORD | string | 登录 LDAP 服务的用户密码 | f00bar |
| YAPI_LDAP_LOGIN_SEARCH_DN | string | 查询用户数据的路径 | ou=users,dc=foo,dc=bar |
| YAPI_LDAP_LOGIN_SEARCH_STANDARD | string | 支持两种值： 1、前端登录账号对应的查询字段，如： mail、uid 等；2、自定义查询条件，其中 %s 会被前端登录账号替换，如：&(objectClass=user)(cn=%s) | - |
| YAPI_LDAP_LOGIN_EMAIL_POSTFIX | string | 登录邮箱后缀 | @163.com |
| YAPI_LDAP_LOGIN_EMAIL_KEY | string | LDAP 数据库存储用户邮箱的字段 | |
| YAPI_LDAP_LOGIN_USERNAME_KEY | string | LDAP 数据库存储用户名的字段 | name |
| 环境变量名称 | 类型 | 说明 | 示例 |
|---|---|---|---|
| YAPI_PLUGINS | json | 要使用的插件列表。点击查看开源 YApi 插件列表 → 配置项数据格式： { "name": "插件名称", "options": "插件配置" } 注意： 安装插件会运行 YApi 自带的打包命令，其内存消耗较大，因此，在安装插件时，物理机可用内存最好大于 1GB，否则，易出现内存溢出错误，导致插件安装失败。 | [{"name":"add-user"},{"name":"gitlab","options":{}}] |