认证方式
所有外部接口都需要传入 API Key。当前默认 Key:plane-gallery-read-key。推荐使用请求头 x-api-key,也可以使用查询参数 key。
plane-gallery-read-key
通用查询参数
筛选字段支持模糊匹配:shotDate、location、model、manufacturer、airline、aircraftAge。关键字参数 q 会搜索原始文件名、图片别名、所有备注信息和动态标签。
图片名称字段
图片对象会返回 originalName、aliasName 和 displayName。originalName 是上传时的原始文件名,不会被修改;aliasName 是后台维护的图片别名,可以为空;外部系统展示名称时直接使用 displayName,它会自动优先返回别名,没有别名时返回原始文件名。
接口列表
| 接口 | 用途 |
|---|---|
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 机场随拍",
"notes": {},
"tags": [],
"previewUrl": "https://...",
"downloadUrl": "https://..."
}