与 Nextjs 集成

使用 Nextjs 应用路由，我们可以在 Nextjs 路由上运行 Elysia。

1. 在应用路由中创建 api/[[...slugs]]/route.ts
2. 在 route.ts 中创建或导入一个现有的 Elysia 服务器
3. 导出您想要与 Elysia.fetch 一起使用的 HTTP 方法

app/api/[[...slugs]]/route.ts

import { Elysia, t } from 'elysia'

const app = new Elysia({ prefix: '/api' })
    .get('/', 'Hello Nextjs')
    .post('/', ({ body }) => body, {
        body: t.Object({
            name: t.String()
        })
    })

export const GET = app.fetch 
export const POST = app.fetch 

Elysia 将正常工作，因为它符合 WinterCG 规范，但如果您在 Node 环境下运行 Nextjs，某些插件（如 Elysia Static）可能不会正常工作。

您可以将 Elysia 服务器视为一个普通的 Nextjs API 路由。

通过这种方式，您可以在一个代码库中将前端和后端共同放置，并在客户端和服务器动作中拥有 Eden 的端到端类型安全。

有关更多信息，请参阅 Nextjs 路由处理程序。

pnpm

如果您使用 pnpm，pnpm 默认不会自动安装 peer 依赖，需要您手动安装额外依赖。

pnpm add @sinclair/typebox openapi-types

前缀

因为我们的 Elysia 服务器不在应用路由的根目录下，所以您需要为 Elysia 服务器注释前缀。

例如，如果您将 Elysia 服务器放在 app/user/[[...slugs]]/route.ts 中，则需要将前缀注释为 /user。

app/user/[[...slugs]]/route.ts

import { Elysia, t } from 'elysia'

const app = new Elysia({ prefix: '/user' }) 
	.get('/', 'Hello Nextjs')
    .post('/', ({ body }) => body, {
        body: t.Object({
            name: t.String()
        })
    })

export const GET = app.fetch
export const POST = app.fetch

这将确保 Elysia 路由能够在您放置它的任何位置正常工作。

Eden

我们可以添加 Eden 来实现类似 tRPC 的端到端类型安全。

1. 从 Elysia 服务器导出 type

app/api/[[...slugs]]/route.ts

import { Elysia } from 'elysia'

export const app = new Elysia({ prefix: '/api' }) 
	.get('/', 'Hello Nextjs')
	.post(
		'/user',
		({ body }) => body,
		{
			body: treaty.schema('User', {
				name: 'string'
			})
		}
	)

export const GET = app.fetch
export const POST = app.fetch

2. 创建 Treaty 客户端

lib/eden.ts

import { treaty } from '@elysiajs/eden'
import type { app } from '../app/api/[[...slugs]]/route'

// .api 用以进入 /api 前缀
export const api =
  // process is defined on server side and build time
  typeof process !== 'undefined'
    ? treaty(app).api
    : treaty<typeof app>('localhost:3000').api

你应该使用 typeof process 而不是 typeof window，因为在构建时 window 未被定义，会导致水合错误。

3. 在服务端和客户端组件中使用该客户端

app/page.tsx

import { api } from '../lib/eden'

export default async function Page() {
	const message = await api.get()

	return <h1>Hello, {message}</h1>
}

这使您能够以最少的工作量从前端到后端实现类型安全，并且同时支持服务器组件、客户端组件以及增量静态再生（ISR）。

React Query

我们也可以使用 React Query 在客户端与 Elysia 服务器进行交互。

src/routes/index.tsx

import { createFileRoute } from '@tanstack/react-router'
import { useQuery } from '@tanstack/react-query'

import { getTreaty } from './api.$'

export const Route = createFileRoute('/a')({
	component: App
})

function App() {
	const { data: response } = useQuery({ 
		queryKey: ['get'], 
		queryFn: () => getTreaty().get() 
	}) 

	return response?.data
}

这可以与任何 React Query 功能一起使用，比如缓存、分页、无限查询等。

---

有关更多信息，请参阅 Next.js 路由处理程序。