https://github.com/fjc0k/yapi-x
YApi 改。
https://github.com/fjc0k/yapi-x
docker yapi yapi-x
Last synced: 6 months ago
JSON representation
YApi 改。
- Host: GitHub
- URL: https://github.com/fjc0k/yapi-x
- Owner: fjc0k
- License: mit
- Created: 2020-02-27T11:30:24.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2022-02-12T09:18:01.000Z (over 3 years ago)
- Last Synced: 2025-03-30T16:11:52.323Z (6 months ago)
- Topics: docker, yapi, yapi-x
- Language: JavaScript
- Size: 16.4 MB
- Stars: 300
- Watchers: 8
- Forks: 43
- Open Issues: 19
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# YApi-X
`YApi-X` 基于 [`YApi v1.8.8`](https://github.com/YMFE/yapi/tree/v1.8.8) 开发，相较原版，有以下改动：
- 接口路径支持更多字符，可以将 `@`、`#`、`;` 等字符用于接口路径定义；
- 支持复制分类；
- 新增 `adminPassword` 配置项以设置管理员密码；
- 项目图标支持自传图片；
- 接口运行支持上传文件（[需安装插件 →](https://github.com/fjc0k/YApi-X/tree/master/chrome-extension#readme)）；
- 请求参数设置下的 Headers 支持批量添加；
- 支持 webdav 扩展的 HTTP 请求方法 PROPFIND, PROPPATCH, MKCOL, COPY, MOVE, LOCK, UNLOCK（[了解更多 →](http://www.webdav.org/specs/rfc2518.html)）；
- 支持为路径参数、查询参数设置类型。
---
- [如何安装](#如何安装)
- [YApi-X 镜像](#yapi-x-镜像)
- [通过 Docker Compose 安装](#通过-docker-compose-安装)
- [运行](#运行)
- [重启](#重启)
- [升级](#升级)
- [迁移](#迁移)
- [日志](#日志)
- [如何配置](#如何配置)
- [基础配置](#基础配置)
- [数据库配置](#数据库配置)
- [邮件配置](#邮件配置)
- [LDAP 登录配置](#ldap-登录配置)
- [插件配置](#插件配置)
## 如何安装
为了节省各自的时间，推荐你使用 **Docker** 安装，同时本文档也不会介绍其他安装方式。
### YApi-X 镜像
- Docker Hub:
[https://hub.docker.com/r/jayfong/yapi-x/tags](https://hub.docker.com/r/jayfong/yapi-x/tags)
### 通过 Docker Compose 安装
以下是一个示例：
```yml
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`，使用以下命令运行：
```bash
docker-compose up -d
```
然后，通过 `http://localhost:40001` 即可访问 `YApi-X`。
#### 重启
若你修改了配置，务必重启应用才能生效：
```bash
docker-compose restart yapi-web
```
#### 升级
`YApi-X` 一旦有更新，你可通过以下命令升级：
```bash
docker-compose pull yapi-web \
&& docker-compose down \
&& docker-compose up -d
```
> 升级不会对原有数据造成任何影响！
#### 迁移
直接打包整个目录去新的服务器即可。
#### 日志
如果出现意外情况，你可通过以下命令查看运行日志：
```bash
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()](https://mongoosejs.com/docs/api/mongoose.html#mongoose_Mongoose-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](https://nodemailer.com/smtp/) | {"tls":{"rejectUnauthorized":false}} |
### LDAP 登录配置
| 环境变量名称 | 类型 | 说明 | 示例 |
| ------------------------------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------- |
| 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 数据库存储用户邮箱的字段 | mail |
| YAPI_LDAP_LOGIN_USERNAME_KEY | string | LDAP 数据库存储用户名的字段 | name |
### 插件配置
| 环境变量名称 | 类型 | 说明 | 示例 |
| ------------ | ---- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------- |
| YAPI_PLUGINS | json | 要使用的插件列表。[点击查看开源 YApi 插件列表 →](https://www.npmjs.com/search?q=yapi-plugin-)
**配置项数据格式：**
{
"name": "插件名称",
"options": "插件配置"
}
**注意：**
安装插件会运行 YApi 自带的打包命令，其内存消耗较大，因此，在安装插件时，物理机可用内存最好大于 `1GB`，否则，易出现内存溢出错误，导致插件安装失败。 | [{"name":"add-user"},{"name":"gitlab","options":{}}] |