Astro 框架潜力巨大,堪称全能型框架。然而,在 API 开发方面,Hono 则更胜一筹:简洁、跨平台兼容,并提供类似 TRPC 但速度更快的基本 RPC 系统。本文将演示如何将两者结合,优势互补。
Astro 项目搭建
首先,创建一个新的 Astro 项目:
npm create astro@latest
按照 CLI 指引完成项目设置。启动项目:
npm run dev
访问 http://localhost:4321 查看项目。
Hono 设置
安装 Hono:
npm install hono
在 src/pages/api/[...path].ts 创建一个新的路由处理所有 API 请求。
创建一个 Hono 实例,注意 .basepath() 的使用,它指定了 Hono 处理请求的路径前缀,需与 Astro 项目结构匹配:
// src/pages/api/[...path].ts import { hono } from 'hono'; const app = new hono().basepath('/api/'); app.get('/posts', async (c) => { return { posts: [ { id: 1, title: 'hello world' }, { id: 2, title: 'goodbye world' }, ], }; });
Hono 与 Astro 集成
Astro 期望导出与 HTTP 方法对应的函数 (例如 get、post 等)。这里,我们将所有请求都委托给 Hono 处理。创建一个 all 导出函数:
// src/pages/api/[...path].ts import { hono } from 'hono'; import type { apiroute } from 'astro'; // ... (Hono 实例 app 的定义) ... export const all: apiroute = (context) => app.fetch(context.request);
现在,http://localhost:4321/api/posts 将返回 Hono 提供的模拟数据。
类型化 RPC 客户端
为了方便 API 调用,并获得类型安全,我们可以使用 Hono 提供的 hc 客户端:
- 导出 Hono 实例的类型:
// src/pages/api/[...path].ts // ... export type App = typeof app;
- 在客户端脚本中创建并使用类型化客户端:
import { hc } from 'hono/client'; import type { App } from './api/[...path].ts'; const client = hc<App>(window.location.href); const response = await client.posts.$get(); const json = await response.json(); console.log(json); // { posts: [...] }
总结
通过以上步骤,你已成功将 Astro 和 Hono 集成,构建了一个类型安全的 API。 Hono 的轻量级特性和强大的功能,使其成为后端开发的理想选择。 鼓励大家尝试使用 Hono,探索其更多可能性。