[{"_1":2,"_161":-5,"_162":-5},"loaderData",{"_3":4,"_17":18,"_25":26,"_140":141},"root",{"_5":-5,"_6":-7,"_7":8,"_9":-7,"_10":11,"_12":-7,"_13":14,"_15":16},"currentUser","primaryEmail","siteVerification","6LeIxAcTAAAAAJcZVRqyHh71UMIEGNQ_MXjiZKhI","toast","enableDev",false,"incidentStatus","theme","system","contrast","normal","routes/_layout",{"_19":-5,"_20":21,"_22":21,"_23":11,"_24":21},"username","isAskGordonEnabled",true,"isUsingNewTemplate","showMinimalLanding","showHoneypotTrap","routes/_layout.r.$namespace.$reponame",{"_27":28,"_29":-5,"_30":11,"_31":11,"_32":33,"_34":35,"_36":-5,"_37":11,"_38":39,"_88":-5,"_89":90,"_129":-5,"_130":11,"_131":21,"_132":11,"_133":-5,"_134":11,"_135":-5,"_136":137,"_138":91,"_139":-7},"canonicalUrl","https://hub.docker.com/r/zhufuyi/yapi/tags","mcpServer","canSeeDockerfile","canSeeAutobuilds","namespace","zhufuyi","reponame","yapi","cloudBuildSource","isAutobuildsAvailable","repo",{"_40":41,"_42":43,"_45":46,"_47":48,"_49":11,"_50":51,"_52":53,"_54":55,"_57":35,"_32":33,"_58":59,"_60":44,"_61":62,"_63":64,"_65":66,"_67":-5,"_68":62,"_69":70,"_71":11,"_72":33,"_73":74,"_79":11,"_80":81,"_85":33,"_86":87},"categories",[],"content_types",[44],"image","date_registered","2023-11-08T09:10:27.795622Z","description","基于 https://github.com/fjc0k/YApi-X 版本的私有部署镜像。","is_private","last_updated","2023-11-08T09:27:10.299385Z","last_modified","2024-10-16T13:48:34.145251Z","media_types",[56],"application/vnd.docker.container.image.v1+json","name","pull_count",22495,"repository_type","star_count",0,"status",1,"status_description","active","source","collaborator_count","full_description","### YApi-X\n\n`YApi-X` 基于 [`YApi v1.8.8`](https://github.com/YMFE/yapi/tree/v1.8.8) 开发，相较原版，有以下改动：\n\n- 接口路径支持更多字符，可以将 `@`、`#`、`;` 等字符用于接口路径定义；\n- 支持复制分类；\n- 新增 `adminPassword` 配置项以设置管理员密码；\n- 项目图标支持自传图片；\n- 接口运行支持上传文件(需安装插件)；\n- 请求参数设置下的 Headers 支持批量添加；\n- 支持 webdav 扩展的 HTTP 请求方法 PROPFIND, PROPPATCH, MKCOL, COPY, MOVE, LOCK, UNLOCK（[了解更多 →](http://www.webdav.org/specs/rfc2518.html)）；\n- 支持为路径参数、查询参数设置类型。\n\n
\n\n### 通过 Docker Compose 安装\n\n`docker-compose.yml` 文件内容如下：\n\n```yaml\nversion: '3'\n\nservices:\n yapi-web:\n image: zhufuyi/yapi:latest\n container_name: yapi-web\n restart: always\n ports:\n - 3000:3000\n environment:\n - YAPI_ADMIN_ACCOUNT=admin@admin.com\n - YAPI_ADMIN_PASSWORD=admin\n - YAPI_CLOSE_REGISTER=true\n - YAPI_DB_SERVERNAME=yapi-mongo\n - YAPI_DB_PORT=27017\n - YAPI_DB_DATABASE=yapi\n - YAPI_MAIL_ENABLE=false\n - YAPI_LDAP_LOGIN_ENABLE=false\n - YAPI_PLUGINS=[]\n depends_on:\n - yapi-mongo\n links:\n - yapi-mongo\n\n yapi-mongo:\n image: mongo:4.4.6\n container_name: yapi-mongo\n restart: always\n volumes:\n - ./data/db:/data/db\n expose:\n - 27017:27017\n```\n\n启动yapi服务：\n\n```bash\ndocker-compose up -d\n```\n\n浏览器访问 `http://localhost:3000`，默认账号：`admin@admin.com`，密码：`admin`。\n\n
\n\n### 环境变量进行配置\n\n#### 基础配置\n\n| 环境变量名称 | 类型 | 说明 | 示例 |\n| ------------------- | ------- | ------------------ | ------------- |\n| YAPI_ADMIN_ACCOUNT | string | 管理员账号（邮箱） | admin@admin.com |\n| YAPI_ADMIN_PASSWORD | string | 管理员密码 | admin |\n| YAPI_CLOSE_REGISTER | boolean | 是否关闭注册 | true |\n\n
\n\n#### 数据库配置\n\n| 环境变量名称 | 类型 | 说明 | 示例 |\n| ---------------------- | ------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------- |\n| YAPI_DB_SERVERNAME | string | MongoDB 服务地址 | yapi-mongo |\n| YAPI_DB_PORT | number | MongoDB 服务端口 | 27017 |\n| YAPI_DB_DATABASE | string | 使用的 MongoDB 数据库 | yapi |\n| YAPI_DB_USER | string | 登录 MongoDB 服务的用户名 | root |\n| YAPI_DB_PASS | string | 登录 MongoDB 服务的用户密码 | root |\n| YAPI_DB_AUTH_SOURCE | string | MongoDB 身份认证所用库 | admin |\n| YAPI_DB_CONNECT_STRING | string | 使用 MongoDB 集群时配置 | mongodb://127.0.0.100:8418,127.0.0.101:8418/yapidb?slaveOk=true |\n| YAPI_DB_OPTIONS | json | Mongoose 连接 MongoDB 服务时的额外选项，一般不用设置。请参考: [Mongoose.prototype.connect()](https://mongoosejs.com/docs/api/mongoose.html#mongoose_Mongoose-connect) | {} |\n\n
\n\n#### 邮件配置\n\n| 环境变量名称 | 类型 | 说明 | 示例 |\n| ------------------- | ------- | --------------------------------------------------------------------------------------------------------------- | ------------------------------------ |\n| YAPI_MAIL_ENABLE | boolean | 是否启用 | true |\n| YAPI_MAIL_HOST | string | 邮件服务地址 | smtp.163.com |\n| YAPI_MAIL_PORT | number | 邮件服务端口 | 465 |\n| YAPI_MAIL_FROM | string | 发送人邮箱 | foo@163.com |\n| YAPI_MAIL_AUTH_USER | string | 登录邮件服务的用户名 | foobar@163.com |\n| YAPI_MAIL_AUTH_PASS | string | 登录邮件服务的用户密码 | foobar |\n| YAPI_MAIL_OPTIONS | json | 传递给 Nodemailer 的额外选项，一般不用设置。请参考：[Nodemailer > SMTP transport](https://nodemailer.com/smtp/) | {\"tls\":{\"rejectUnauthorized\":false}} |\n\n
\n\n#### LDAP 登录配置\n\n| 环境变量名称 | 类型 | 说明 | 示例 |\n| ------------------------------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------- |\n| YAPI_LDAP_LOGIN_ENABLE | boolean | 是否启用 | true |\n| YAPI_LDAP_LOGIN_SERVER | string | LDAP 服务地址 | ldap://ldap.foo.bar |\n| YAPI_LDAP_LOGIN_BASE_DN | string | 登录 LDAP 服务的用户名 | cn=admin,dc=foo,dc=bar |\n| YAPI_LDAP_LOGIN_BIND_PASSWORD | string | 登录 LDAP 服务的用户密码 | foobar |\n| YAPI_LDAP_LOGIN_SEARCH_DN | string | 查询用户数据的路径 | ou=users,dc=foo,dc=bar |\n| YAPI_LDAP_LOGIN_SEARCH_STANDARD | string | 支持两种值：
1、前端登录账号对应的查询字段，如：`mail`、`uid` 等；
2、自定义查询条件，其中 `%s` 会被前端登录账号替换，如：`&(objectClass=user)(cn=%s)` | - |\n| YAPI_LDAP_LOGIN_EMAIL_POSTFIX | string | 登录邮箱后缀 | @163.com |\n| YAPI_LDAP_LOGIN_EMAIL_KEY | string | LDAP 数据库存储用户邮箱的字段 | mail |\n| YAPI_LDAP_LOGIN_USERNAME_KEY | string | LDAP 数据库存储用户名的字段 | name |\n\n
\n\n#### 插件配置\n\n| 环境变量名称 | 类型 | 说明 | 示例 |\n| ------------ | ---- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------- |\n| YAPI_PLUGINS | json | 要使用的插件列表。[点击查看开源 YApi 插件列表 →](https://www.npmjs.com/search?q=yapi-plugin-)
**配置项数据格式：**
{
\"name\": \"插件名称\",
\"options\": \"插件配置\"
}
**注意：**
安装插件会运行 YApi 自带的打包命令，其内存消耗较大，因此，在安装插件时，物理机可用内存最好大于 `1GB`，否则，易出现内存溢出错误，导致插件安装失败。 | [{\"name\":\"add-user\"},{\"name\":\"gitlab\",\"options\":{}}] |\n","has_starred","hub_user","immutable_tags_settings",{"_75":11,"_76":77},"enabled","rules",[78],".*","is_automated","permissions",{"_82":21,"_83":11,"_84":11},"read","write","admin","user","storage_size",112682492,"orgData","recentTags",[91],{"_92":44,"_93":94,"_95":96,"_97":98,"_99":100,"_101":102,"_50":118,"_119":94,"_120":33,"_121":56,"_57":122,"_123":124,"_125":109,"_126":118,"_127":66,"_128":21},"content_type","creator",5529637,"digest","sha256:2c579be740b5233b18cd1f7c00b4fd1af08da0b403fe76b23f9b3c2a168eb254","full_size",112673444,"id",545412910,"images",[103],{"_104":105,"_95":96,"_106":107,"_108":109,"_110":111,"_112":113,"_114":107,"_115":-5,"_116":98,"_63":66,"_117":-5},"architecture","amd64","features","","last_pulled","2026-10-02T19:16:36.391344743Z","last_pushed","2021-05-20T08:46:52Z","os","linux","os_features","os_version","size","variant","2023-11-08T09:27:10.289161Z","last_updater","last_updater_username","media_type","latest","repository",22398287,"tag_last_pulled","tag_last_pushed","tag_status","v2","sbxKitMetadata","isPotentialSpam","isHubSbxKitsEnabled","showSbxLogoOverride","sbxTrademarkText","displaySecurityMetadata","tagAttestations","tagsHaveAttestations",[],"selectedTag","attestationsUrl","routes/_layout.r.$namespace.$reponame.tags",{"_38":142,"_149":150,"_136":159,"_160":11},{"_40":143,"_42":144,"_45":46,"_47":48,"_49":11,"_50":51,"_52":53,"_54":145,"_57":35,"_32":33,"_58":59,"_60":44,"_61":62,"_63":64,"_65":66,"_67":-5,"_68":62,"_69":70,"_71":11,"_72":33,"_73":146,"_79":11,"_80":148,"_85":33,"_86":87},[],[44],[56],{"_75":11,"_76":147},[78],{"_82":21,"_83":11,"_84":11},"tags",{"_151":64,"_152":-5,"_153":-5,"_154":155},"count","next","previous","results",[156],{"_92":44,"_93":94,"_95":96,"_97":98,"_99":100,"_101":157,"_50":118,"_119":94,"_120":33,"_121":56,"_57":122,"_123":124,"_125":109,"_126":118,"_127":66,"_128":21},[158],{"_104":105,"_95":96,"_106":107,"_108":109,"_110":111,"_112":113,"_114":107,"_115":-5,"_116":98,"_63":66,"_117":-5},[],"canDeleteTags","actionData","errors"]

zhufuyi/yapi

Tags for zhufuyi/yapi