飞机图片 API 文档

外部系统使用简单 Key 认证访问图片索引、搜索、详情、预览和完整下载。

认证方式

所有外部接口都需要传入 API Key。当前默认 Key:plane-gallery-read-key。推荐使用请求头 x-api-key,也可以使用查询参数 key。

plane-gallery-read-key

通用查询参数

筛选字段支持模糊匹配:shotDate、location、model、manufacturer、airline、aircraftAge。上传者支持精确匹配:uploader 或 uploadedBy。关键字参数 q 会搜索原始文件名、图片别名、所有备注信息和动态标签。

图片名称字段

图片对象会返回 originalName、aliasName 和 displayName。originalName 是上传时的原始文件名,不会被修改;aliasName 是后台维护的图片别名,可以为空;外部系统展示名称时直接使用 displayName,它会自动优先返回别名,没有别名时返回原始文件名。

公开与上传者字段

外部接口只返回已勾选公共页面显示的图片。每个图片对象会返回 isPublic、uploadedBy 和 uploader;其中 isPublic=true 表示允许在公共页面和小程序展示,uploadedBy/uploader 表示上传账号。列表接口还会在 options.uploaders 返回当前公开图片涉及的上传账号列表。

接口列表

接口用途
GET /plane-gallery/external-api/index快速索引,返回图片 ID、原始文件名、图片别名、展示名称、公开状态、上传者、备注、标签、预览和下载链接。
GET /plane-gallery/external-api/search备注字段检索与关键字搜索。
GET /plane-gallery/external-api/images/{id}读取单张图片完整信息。
GET /plane-gallery/external-api/images/{id}/preview读取 800x600 小图预览。
GET /plane-gallery/external-api/images/{id}/download下载原始图片文件。

示例

curl -H "x-api-key: plane-gallery-read-key" \
  "https://gouyunjp.arthurjiang.net.cn/plane-gallery/external-api/search?q=787"

curl "https://gouyunjp.arthurjiang.net.cn/plane-gallery/external-api/index?key=plane-gallery-read-key"

返回示例

{
  "id": "image-id",
  "originalName": "IMG_5649.JPG",
  "aliasName": "LoveArthur 机场随拍",
  "displayName": "LoveArthur 机场随拍",
  "isPublic": true,
  "uploadedBy": "lovearthur",
  "uploader": "lovearthur",
  "notes": {},
  "tags": [],
  "previewUrl": "https://...",
  "downloadUrl": "https://..."
}