orva

English README | 中文文档站

面向 Fetch API 的轻量 TypeScript Web 框架，提供 typed middleware、validator、RPC、OpenAPI 与多运行时适配能力。

安装

pnpm add orvajs

快速开始

import { createOrva } from 'orvajs';
import { serveNode } from 'orvajs/adapters/node';
import { cors, requestId, secureHeaders } from 'orvajs/middlewares';

const app = createOrva()
  .use(requestId(), cors(), secureHeaders())
  .get('/health', (c) => c.json({ ok: true, requestId: c.get('requestId') }));

serveNode(app, { port: 3000 });

文档入口

• 英文 README: README.md
• 中文文档站: https://jieceng.github.io/orva/zh/
• 中文快速开始: https://jieceng.github.io/orva/zh/guide/quickstart
• 英文文档站: https://jieceng.github.io/orva/

包结构

根入口 orvajs 只导出核心框架能力，生态模块建议使用子路径导入：

import { createOrva, defineMiddleware } from 'orvajs';
import { validator } from 'orvajs/validator';
import { zodValidator } from 'orvajs/validator/zod';
import { createRPC } from 'orvajs/rpc';
import { createOpenAPIDocument } from 'orvajs/openapi';
import { serveNode } from 'orvajs/adapters/node';
import { cors } from 'orvajs/middlewares/cors';

类型化 validator 与 RPC

validator 的输出会同时流入路由 handler 上下文和 RPC 客户端入参：

import { createOrva } from 'orvajs';
import { createRPC } from 'orvajs/rpc';
import { validator } from 'orvajs/validator';

const app = createOrva()
  .get('/posts/:id', (c) => c.json({ id: c.params.id, title: 'Post details' }))
  .post(
    '/users',
    validator('json', (value: any) => ({
      name: String(value.name ?? ''),
      age: Number(value.age ?? 0),
    })),
    (c) => c.json({ ok: true, user: c.valid('json') }),
  );

const rpc = createRPC<typeof app>({
  baseURL: 'https://api.example.com',
});

const post = await rpc.posts[':id'].$get({ param: { id: '123' } });
const detail = await post.json();

await rpc.users.$post({
  body: {
    name: 'Ada',
    age: 20,
  },
});

这里：

• detail 会被推导成 { id: string; title: string }
• rpc.users.$post() 的 body 会被推导成 { name: string; age: number }

常用链接

• GitHub: https://github.com/jieceng/orva
• npm: https://www.npmjs.com/package/orvajs
• 中文文档: https://jieceng.github.io/orva/zh/

许可证

MIT