Skip to content

Self-hosted personal gallery application with online photo management and albums, supporting Live/Motion Photos, EXIF parsing, geolocation recognition, and an explore map.

2.1 KB
Raw Blame

API 概览

API 与网页使用同一套会话认证。需要登录的请求携带登录后获得的 Cookie;后台设置和管理操作还会检查管理员权限。

::: info 接口范围 接口可能随版本调整。接入前请查看 server/api/ 中对应路由的参数、响应和权限校验。 :::

方法 路径 用途
POST /api/login 邮箱密码登录,设置会话 Cookie
GET /api/auth/github GitHub OAuth 登录回调
GET /api/photos 登录用户读取照片列表
GET /api/photos/visible 公开可见照片,排除隐藏和密码相册中的照片
GET /api/albums 读取可访问的相册
POST /api/albums/:albumId/unlock 使用密码解锁相册
GET /api/system/settings/fields?namespace=app 读取设置表单字段(管理员)
PUT /api/system/settings/batch 批量保存设置(管理员)
GET /api/queue/recent 后台最近任务
GET /api/system/logs 后台日志

批量修改设置

管理员会话下向 /api/system/settings/batch 发送 PUT 请求:

{
  "updates": [
    { "namespace": "app", "key": "title", "value": "My Gallery" },
    { "namespace": "app", "key": "slogan", "value": "Photos from my travels" }
  ]
}

新增设置或修改设置表单,请阅读设置开发指南。

::: warning 后台接口不是公开照片接口 照片读取需要遵守相册可见性和密码访问规则,不要将后台照片列表当作公开接口使用。 :::