From e257a40fb90f42a03fe22ab2ecf49a6ae922d2ce Mon Sep 17 00:00:00 2001 From: MarSeventh <1193267292@qq.com> Date: Mon, 15 Jun 2026 14:40:11 +0800 Subject: [PATCH] docs(api): add endpoint file headers --- functions/api/channels.js | 5 ++++- functions/api/fetchRes.js | 6 +++++- functions/api/public/list.js | 4 ++++ functions/api/userConfig.js | 4 ++++ 4 files changed, 17 insertions(+), 2 deletions(-) diff --git a/functions/api/channels.js b/functions/api/channels.js index 0243c1cd..1df1e68e 100644 --- a/functions/api/channels.js +++ b/functions/api/channels.js @@ -1,4 +1,7 @@ -// 获取上传渠道列表 API +/** + * 上传渠道列表 API + * 负责在鉴权后返回当前可用或全部上传渠道的名称与类型 + */ import { fetchUploadConfig } from '../utils/sysConfig.js'; import { getUploadConfig } from './manage/sysConfig/upload.js'; import { getDatabase } from '../utils/databaseAdapter.js'; diff --git a/functions/api/fetchRes.js b/functions/api/fetchRes.js index 32996a10..dadfc77c 100644 --- a/functions/api/fetchRes.js +++ b/functions/api/fetchRes.js @@ -1,3 +1,7 @@ +/** + * 远程资源代理读取 API + * 负责在鉴权后拉取请求体中指定 URL 的资源并透传响应内容 + */ import { dualAuthCheck } from '../utils/auth/dualAuth.js'; export async function onRequest(context) { @@ -31,4 +35,4 @@ export async function onRequest(context) { return new Response(response.body, { headers: headers }) -} \ No newline at end of file +} diff --git a/functions/api/public/list.js b/functions/api/public/list.js index 021d2645..fbf6f57b 100644 --- a/functions/api/public/list.js +++ b/functions/api/public/list.js @@ -1,3 +1,7 @@ +/** + * 公开文件列表 API + * 负责按公开浏览配置返回可访问文件和目录列表,并维护列表缓存 + */ import { fetchOthersConfig } from "../../utils/sysConfig"; import { readIndex } from '../../utils/indexManager.js'; diff --git a/functions/api/userConfig.js b/functions/api/userConfig.js index 53096d46..d78b6212 100644 --- a/functions/api/userConfig.js +++ b/functions/api/userConfig.js @@ -1,3 +1,7 @@ +/** + * 用户端页面配置 API + * 负责读取页面配置并转换为前端可直接使用的用户配置对象 + */ import { fetchPageConfig } from "../utils/sysConfig"; export async function onRequest(context) {