Skip to content

orva以“学会”为目标的服务端框架文档

先跑起一个 Fetch API 服务,再循序渐进接入 validator、typed RPC、OpenAPI 和生产中间件,不需要切换心智模型。

从这里开始

如果你是第一次使用 orva,建议按这个顺序学习:

  1. 快速开始:几分钟内跑起真实服务
  2. Context 与响应:掌握请求读取和响应辅助
  3. 路由与组合:学会拆分路由且不丢类型
  4. 类型链路:理解 middleware、validator、RPC、OpenAPI 如何贯通
  5. Recipes:开始做接近生产的应用

如果你是从其他 Node 或 Fetch 框架迁移过来,建议尽早阅读 从 Express / Hono 迁移

orva 擅长什么

  • 基于 Fetch API 的小心智请求模型
  • 明确的子路径导出,适合核心框架、RPC、adapters、validator、中间件、OpenAPI 分层使用
  • 在运行时校验、handler 上下文、RPC 客户端、OpenAPI 输出之间复用契约
  • 面向 Node、Bun、Deno、Serverless、Edge 的部署能力
01

Request

统一以 Fetch API Request 进入应用,平台适配器只负责把宿主请求桥接进来。

02

Validator

json / form / query / param / header / cookie / text 输入统一进入类型安全校验链。

03

Route

Context、Middleware、路由组合保持直观,业务逻辑集中在 handler 层。

04

Contracts

校验元数据继续流向 RPC 与 OpenAPI,减少客户端、文档和运行时代码漂移。

第一段真正有用的服务

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

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

serveNode(app, { port: 3000 });

按任务学习

目标对应页面
跑起第一个服务快速开始
理解请求模型Context 与响应
理解契约传播类型链路
构建 REST APIREST API Recipe
构建 typed client 工作流Typed RPC App Recipe
组装生产可用的中间件栈Middleware Cookbook
从其他框架迁移现有服务迁移指南
查询模块和导出参考资料

参考资料入口

能力域入口
核心框架参考资料总览
ValidatorValidator
RPCRPC
OpenAPIOpenAPI
Middleware中间件目录
Adapters适配器

Built with VitePress. Structured for production docs, multilingual delivery and long-term versioning.