# @atproto/xrpc-server 中文文档

规范地址：https://npmcn.com/package/%40atproto/xrpc-server/

版本：0\.13\.9
npm 元数据更新时间：2026-11-06T01:45:48.367Z
中文译文更新时间：2026-11-07T03:53:24.035Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40atproto/xrpc-server
原文对照：https://npmcn.com/package/%40atproto/xrpc-server/?lang=original
项目主页：https://atproto.com/
源码仓库：https://github.com/bluesky-social/atproto

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

- 包体积（解压后）：373 kB，68 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=22
- 运行依赖：16 个
- 首次发布：2023-01-24T00:10:00.492Z
- 最新版本发布：2026-11-06T01:45:47.855Z
- 近 30 天下载量：55660（2026-10-07 至 2026-11-05，npm 官方下载统计）
- 已发布版本数：118（近 12 个月 67 个）

## 中文简介

atproto HTTP API (XRPC) 服务器库

## 安装

```sh
npm install @atproto/xrpc-server
```

也可以使用：`pnpm add @atproto/xrpc-server`、`yarn add @atproto/xrpc-server`、`bun add @atproto/xrpc-server`

## README

# @atproto/xrpc- server: atproto HTTP API 服务器库

用于执行的脚本库类型 [原子弹](https://atproto.com/) HTTP API服务,带有Lexicon schema验证.

[![NPM](https://img.shields.io/npm/v/@atproto/xrpc-server)](https://www.npmjs.com/package/@atproto/xrpc-server) [![Github CI Status](https://github.com/bluesky-social/atproto/actions/workflows/repo.yaml/badge.svg)](https://github.com/bluesky-social/atproto/actions/workflows/repo.yaml)

## 使用量

```typescript
import { LexiconDoc } from '@atproto/lexicon'
import * as xrpc from '@atproto/xrpc-server'
import express from 'express'

const lexicons: LexiconDoc[] = [
  {
    lexicon: 1,
    id: 'io.example.ping',
    defs: {
      main: {
        type: 'query',
        parameters: {
          type: 'params',
          properties: { message: { type: 'string' } },
        },
        output: {
          encoding: 'application/json',
        },
      },
    },
  },
]

// create xrpc server
const server = xrpc.createServer(lexicons)

function ping(ctx: {
  auth: xrpc.HandlerAuth | undefined
  params: xrpc.Params
  input: xrpc.HandlerInput | undefined
  req: express.Request
  res: express.Response
}) {
  return { encoding: 'application/json', body: { message: ctx.params.message } }
}

server.method('io.example.ping', ping)

// mount in express
const app = express()
app.use(server.router)
app.listen(8080)
```

## 许可证

根据麻省理工学院和Apache 2.0条款,这个项目具有双重许可证:

-   麻省理工学院许可证[LICENSE-MIT.txt (英语)](https://github.com/bluesky-social/atproto/blob/main/LICENSE-MIT.txt) 或者说 [http://opensource.org/licenses/MIT 互联网档案馆的存檔,存档日期2013-12-02](http://opensource.org/licenses/MIT)(中文(简体) )
-   Apache 许可证,2.0版本, ([(原始内容存档于2017-09-31) (英语). LICENSE-APACHE.txt](https://github.com/bluesky-social/atproto/blob/main/LICENSE-APACHE.txt) 或者说 [http://www.apache.org/licenses/LICENSE-2.0 (中文(简体) )](http://www.apache.org/licenses/LICENSE-2.0)(中文(简体) )

下游项目和终端用户可自行选择单独或共同发放许可证。 这种双重许可的动机是Apache 2.0提供的额外软件专利保证.

## 常见问题

### @atproto/xrpc-server 是什么？

atproto HTTP API \(XRPC\) 服务器库

### 如何安装 @atproto/xrpc-server？

在项目目录运行 npm install @atproto/xrpc-server，或使用 pnpm add / yarn add / bun add。

### @atproto/xrpc-server 支持 TypeScript 吗？

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

### @atproto/xrpc-server 支持 ESM 还是 CommonJS？

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

### @atproto/xrpc-server 需要什么版本的 Node\.js？

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

### @atproto/xrpc-server 可以商用吗？

@atproto/xrpc-server 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @atproto/xrpc-server 的下载量有多少？

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

### @atproto/xrpc-server 还在维护吗？

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