> 技术文档 > 二开----02

二开----02


1. 技术背景

你的项目采用了 Next.js(app 目录结构),其 app/api/ 目录下的文件和子目录用于实现前端 API 路由。这些 API 路由既可以代理后端接口,也可以直接处理部分业务逻辑。前端页面通过 fetch/axios 等方式调用 /api/xxx 路径,Next.js 会将请求路由到 app/api/ 下对应的 handler。


2. 路由结构与映射关系

app/api/ 目录为例,目录结构如下:

app/ api/ audio-to-text/ route.ts chat-messages/ [taskId]/ ... route.ts conversations/ [conversationId]/ ... route.ts file-upload/ remote/ ... route.ts info/ route.ts messages/ [messageId]/ ... route.ts meta/ route.ts parameters/ route.ts utils/ common.ts

路由规则说明

  • app/api/xxx/route.ts/api/xxx
    例如:app/api/info/route.ts 对应 /api/info
  • 动态参数:
    例如:app/api/messages/[messageId]/route.ts 对应 /api/messages/:messageId
  • 多级嵌套:
    例如:app/api/file-upload/remote/route.ts 对应 /api/file-upload/remote

3. 典型交互流程

1)前端调用

前端页面通过如下方式调用 API:

fetch(\'/api/messages/12345\', { method: \'GET\' })

Next.js 会将请求路由到 app/api/messages/[messageId]/route.ts,并将 messageId 解析为 12345

2)API 路由处理

route.ts 为例,通常会这样写(伪代码):

// app/api/messages/[messageId]/route.tsimport { NextRequest, NextResponse } from \'next/server\';export async function GET(request: NextRequest, { params }) { const { messageId } = params; // 这里可以直接处理,也可以转发到后端 const data = await fetch(`http://后端服务/messages/${messageId}`); const result = await data.json(); return NextResponse.json(result);}
  • GETPOSTPUTDELETE 等方法分别对应 HTTP 请求方法。
  • params 自动解析 URL 中的动态参数。

3)与后端服务交互

API 路由内部通常会通过 fetch/axios 等方式转发请求到后端服务,如:

await fetch(\'http://backend-service/api/xxx\', { ... })

这样前端页面只需关心 /api/xxx,不需要直接暴露后端真实地址,便于安全和跨域管理。


4. 目录和路由映射举例

文件路径 对应 API 路径 说明 app/api/info/route.ts /api/info 获取系统信息等 app/api/messages/[messageId]/route.ts /api/messages/:messageId 获取/操作指定消息 app/api/chat-messages/route.ts /api/chat-messages 聊天消息相关 app/api/conversations/[conversationId]/route.ts /api/conversations/:conversationId 单个会话相关 app/api/file-upload/remote/route.ts /api/file-upload/remote 远程文件上传 app/api/audio-to-text/route.ts /api/audio-to-text 语音转文字

5. 交互优势

  • 前后端解耦:前端只需调用 /api/xxx,后端地址可灵活配置。
  • 安全性:隐藏后端真实接口,便于权限和安全控制。
  • 灵活性:可在 API 路由中做缓存、鉴权、数据预处理等。

6. 典型代码片段

// app/api/info/route.tsimport { NextResponse } from \'next/server\';export async function GET() { // 直接返回数据,或转发到后端 const res = await fetch(\'http://backend-service/info\'); const data = await res.json(); return NextResponse.json(data);}

总结

  • app/api/ 目录下的 route.ts 文件定义了前端 API 路由。
  • 路由规则与目录结构一一对应,支持动态参数。
  • API 路由内部可直接处理请求,也可转发到后端服务。
  • 前端页面通过 /api/xxx 统一访问,后端实现细节被隐藏。