import {type PolicySection} from "./types" import {CodeBlock} from "@/components/ui/code-block" import { DocsTable, DocsTableBody, DocsTableCell, DocsTableHead, DocsTableHeader, DocsTableRow, } from "@/components/ui/docs-table" export const DOCS_LAST_UPDATED = "2026-06-07" /** * ------------------------------------------------------------------ * API 文档 * ------------------------------------------------------------------ */ export const apiSections: PolicySection[] = [ { value: "api-specs", title: "1. 接口规范与鉴权说明", content: (
平台统一接口调用格式规范以及开发者访问令牌鉴权方式说明
系统所有 API 接口均遵循标准 JSON 响应结构:
成功响应示例:
失败响应示例:
除了公共公开接口(如登录、注册、配置)外,受保护的接口需要携带凭证才能正常访问:
支持携带令牌的请求头格式(二选一):
Authorization: Bearer at_xxxX-Access-Token: at_xxx接口:POST /api/v1/user/register
说明:注册本地账户(在后台注册开关开启状态下)。
接口:POST /api/v1/user/login
说明:通过常规用户名密码进行登录校验,成功后建立 Session Cookie 会话。
接口:GET /api/v1/user/logout
说明:销毁当前会话 Cookie 并退出登录状态。
接口:GET /api/v1/user/self
说明:获取当前登录账户的基本数据模型(包含 ID、角色、昵称等)。
AccessToken 管理相关接口均要求通过 Session 登录后调用,支持普通用户权限。
接口:GET /api/v1/user/access-tokens
说明:查询当前用户已创建的所有令牌详情(令牌明文已被脱敏)。
接口:POST /api/v1/user/access-tokens
参数:JSON Body {`{"name": "token名称", "is_admin": false}`}
说明:生成一个全新访问令牌。返回体中包含一次性明文 Token,切勿遗失。
is_admin(可选,默认 false):是否赋予令牌管理员权限,仅管理员用户可设置。非管理员令牌无法访问 /admin/** 端点。
成功返回样例:
接口:DELETE /api/v1/user/access-tokens/:id
说明:通过 ID 物理删除对应访问令牌,该令牌将立即失效。
接口:POST /api/v1/user/access-tokens/:id/rotate
说明:轮换指定令牌的物理密钥值。系统将废弃原有密钥,返回新生成的明文 Token,令牌名称与 ID 保持一致。
接口:GET /api/v1/config/public
说明:无感获取当前系统配置表中公共可见的键值集合。供前端页面动态渲染使用。
返回数据结构样例:
说明:用于在后台对 `system_configs` 配置进行动态变更,要求管理员权限会话调用。
/api/v1/admin/system-configs?type=system/api/v1/admin/system-configs/api/v1/admin/system-configs/:key/api/v1/admin/system-configs/:key