# @appport/schema 中文文档

规范地址：https://npmcn.com/package/%40appport/schema/

版本：1\.1\.5
npm 元数据更新时间：2026-11-05T17:19:33.988Z
中文译文更新时间：2026-11-06T19:52:39.189Z
软件包许可：Apache-2\.0

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40appport/schema
原文对照：https://npmcn.com/package/%40appport/schema/?lang=original
项目主页：https://github.com/rkendel1/appport#readme
源码仓库：https://github.com/rkendel1/appport

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：74.3 kB，27 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=20
- 运行依赖：1 个
- 首次发布：2026-09-21T13:19:49.043Z
- 最新版本发布：2026-11-05T17:19:33.812Z
- 近 30 天下载量：2424（2026-10-07 至 2026-11-05，npm 官方下载统计）
- 已发布版本数：10（近 12 个月 10 个）

## 中文简介

Schema适配器和JSON Schema生成,用于AppPort能力.

## 安装

```sh
npm install @appport/schema
```

也可以使用：`pnpm add @appport/schema`、`yarn add @appport/schema`、`bun add @appport/schema`

## README

# @ appport/ schema

Schema适配器和JSON Schema生成,用于AppPort能力.

AppPort在电线上发布 JSON Schema , 从而可以从 TypeScript, Rust, Go, Python 或 Swift (英语). 在 TypeScript 中,您可以编写三套方案 方法,和所有三个发布 同样的事情.

```ts
import { s, fromJSONSchema, fromStandardSchema, toSchema } from "@appport/schema";

// 1. the built-in builder: validation and JSON Schema from one definition
const input = s.object({ documentId: s.string(), title: s.optional(s.string()) });

// 2. any Standard Schema library (Zod, Valibot, ArkType)
const zodInput = fromStandardSchema(zodSchema, { jsonSchema: z.toJSONSchema(zodSchema) });

// 3. a raw JSON Schema document, validated at runtime
const published = fromJSONSchema({ type: "object", required: ["documentId"] });
```

`fromJSONSchema` 是让生成的客户端对已发布的进行校验的内容 与原始定义相同的能力a 第三方执行已经.

构建者覆盖了字符串,数字,整数,布尔斯,虚数,字形,enums, 数组、对象、记录、结合、可选、可失效、时间戳和二进制 参考文献,并附有全部类型推论:

```ts
type Input = Infer<typeof input>; // { documentId: string; title?: string }
```

## 语义说明

JSON Schema说价值的形状是什么,而不是它的含义: `90` 是有效的数字 无论是分钟还是小时. `annotate` 发表 `x-appport-*` 关键词 说一个字段是什么,而不改变它是如何验证的:

```ts
import { annotate, s, semantic } from "@appport/schema";

const estimatedHours = annotate(
  s.number({ minimum: 0 }),
  semantic({ concept: "https://vocab.example.org/work-order#effort", unit: "h" })
);
const priority = annotate(s.enum(["low", "urgent"]), semantic({
  enumConcepts: { low: "https://vocab.example.org/urgency#low", urgent: "https://vocab.example.org/urgency#high" }
}));
```

仅 `x-` 键被接受, `x-appport-*` 立即检查值(概念是 绝对IRI,单位没有空白, `enumConcepts` 名称已声明enum值, `encoding` 实值 `iso8601`, (中文(简体) ), `epoch-seconds` 或者说 `epoch-milliseconds`),可选性是 保留了下来 见 `spec/appport-1.0.md` 第15.3.节.

## 常见问题

### @appport/schema 是什么？

Schema适配器和JSON Schema生成,用于AppPort能力\.

### 如何安装 @appport/schema？

在项目目录运行 npm install @appport/schema，或使用 pnpm add / yarn add / bun add。

### @appport/schema 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @appport/schema 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### @appport/schema 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>=20。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @appport/schema 可以商用吗？

@appport/schema 使用 Apache-2\.0 许可。宽松许可：允许商业使用、修改和再分发，并附带明确的专利授权；分发时需保留许可与 NOTICE 文件，修改过的文件要注明改动。以上为概括，不构成法律意见，请以许可原文为准。

### @appport/schema 的下载量有多少？

根据 npm 官方下载统计，@appport/schema 在 2026/10/07 – 2026/11/05 这 30 天内被下载 2,424 次，日均约 81 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @appport/schema 还在维护吗？

最新版本 1\.1\.5 发布于 2026/11/06（2 天前）；至今共发布 10 个版本，其中过去 12 个月发布了 10 个；首次发布于 2026/09/21。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。