# @antelopejs/interface-auth 中文文档

规范地址：https://npmcn.com/package/%40antelopejs/interface-auth/

版本：0\.2\.0
npm 元数据更新时间：2026-11-04T19:14:01.023Z
中文译文更新时间：2026-11-06T06:27:45.769Z
软件包许可：Apache-2\.0

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

原始 npm 页面：https://www.npmjs.com/package/%40antelopejs/interface-auth
原文对照：https://npmcn.com/package/%40antelopejs/interface-auth/?lang=original
项目主页：https://interfaces.antelopejs.com/docs/auth
源码仓库：https://github.com/AntelopeJS/interface-auth

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

- 包体积（解压后）：103 kB，26 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- 运行依赖：0 个
- peer 依赖：@antelopejs/interface-api \>=0\.0\.15 \<1\.0\.0，@antelopejs/interface-core \>=0\.2\.4 \<1\.0\.0
- 首次发布：2026-03-22T17:02:51.127Z
- 最新版本发布：2026-11-04T19:14:00.656Z
- 近 30 天下载量：7109（2026-10-06 至 2026-11-04，npm 官方下载统计）
- 已发布版本数：8（近 12 个月 8 个）

## 中文简介

用于令牌认证的羚羊JS接口:签名并验证令牌并给已核实的有效载荷注入API处理器

## 安装

```sh
npm install @antelopejs/interface-auth
```

也可以使用：`pnpm add @antelopejs/interface-auth`、`yarn add @antelopejs/interface-auth`、`bun add @antelopejs/interface-auth`

## README

# `@antelopejs/interface-auth`

[![npm](https://img.shields.io/npm/v/@antelopejs/interface-auth?style=for-the-badge&labelColor=000000&color=000000)](https://www.npmjs.com/package/@antelopejs/interface-auth) [![License](https://img.shields.io/npm/l/@antelopejs/interface-auth?style=for-the-badge&labelColor=000000&color=000000)](https://npmcn.com/package/%40antelopejs/interface-auth/LICENSE) [![Discord](https://img.shields.io/badge/Discord-18181B?logo=discord&style=for-the-badge&color=000000)](https://discord.gg/g4pFt6eXqu) [![Docs](https://img.shields.io/badge/Docs-18181B?style=for-the-badge&color=000000)](https://interfaces.antelopejs.com/docs/auth)

藏羚羊JS的令牌认证合同:签署并验证令牌,并用装饰器将已核实的有效载荷注入API处理器.

部分 [羚羊JS](https://github.com/AntelopeJS/antelopejs), 模块依赖合同且应用程序选择提供者的TypeScript框架. 由后面的团队建造 [羚羊JS 隐形物](https://github.com/AntelopeJS/dms)。 。 。 .

## 它提供的东西

-   `SignRaw` 财务报告和审定财务报表 `ValidateRaw` 将有效载荷签入一个代号,并核实一个代号返回其有效载荷.
-   `SignServerResponse` 签署有效载荷,并将该符号作为饼干附在反应上.
-   `@Authentication()` 从 `x-antelopejs-auth` 标题,或来自 `ANTELOPEJS_AUTH` 当信头缺席时做曲奇. 它验证了符号,并将有效载荷注入了处理器参数.
-   `CreateAuthDecorator` 使用自定义的源、 校验器和校验器构建您的装饰 .

## 执行情况

| 模块 | 页:1 |
| --- | --- |
| [`@antelopejs/auth-jwt`](https://github.com/AntelopeJS/auth-jwt) | JSON 网络键 |

## 安装

将界面添加到保护路径的模块中 :

```bash
pnpm add @antelopejs/interface-auth
```

然后在项目中添加一个执行,同时实施API接口:

```bash
ajs project modules add @antelopejs/auth-jwt @antelopejs/api
```

## 快开始

```ts
import { Controller, Get, Post } from "@antelopejs/interface-api";
import { Authentication, SignRaw } from "@antelopejs/interface-auth";

interface Session {
  id: string;
}

export class SessionController extends Controller("/session") {
  @Post("login")
  async login() {
    return SignRaw({ id: "user-7" }, { expiresIn: "1h" });
  }

  @Get("me")
  async me(@Authentication() session: Session) {
    return { id: session.id };
  }
}
```

请求 `GET /session/me` 处理器运行前没有有效的符号失败 。 发送符号不变 `x-antelopejs-auth`,没有 `Bearer` 前缀。 这个 `login` 方法只显示签名。 在真正的申请中,在签发代币前先检查证书.

这个 `Session` 注释描述应用程序预期的有效载荷。 它不检查它,所以 `session.id` 无论是什么 已经核实的标志携带。 添加一个 [形状检查验证器](https://npmcn.com/package/%40antelopejs/interface-auth/docs/2.authentication.md#create-a-custom-verifier) 之前,您要依赖任何格式都无法执行的标志.

## 文档

-   [导言](https://npmcn.com/package/%40antelopejs/interface-auth/docs/1.introduction.md)
-   [认证](https://npmcn.com/package/%40antelopejs/interface-auth/docs/2.authentication.md)
-   [控件处理](https://npmcn.com/package/%40antelopejs/interface-auth/docs/3.token-handling.md)
-   [参数装饰](https://npmcn.com/package/%40antelopejs/interface-auth/docs/4.parameter-decoration.md)

## 兼容性

模块宣布这些对等关系:

| 软件包 | 支助 | 测试过 |
| --- | --- | --- |
| `@antelopejs/interface-api` | `>=0.0.15 <1.0.0` | `0.2.0` |
| `@antelopejs/interface-core` | `>=0.2.4 <1.0.0` | `0.4.0` |

## 捐款

读取 [捐款额](https://npmcn.com/package/%40antelopejs/interface-auth/CONTRIBUTING.md) 在你打开拉动请求之前。 当地检查为:

```bash
pnpm install
pnpm lint
pnpm test
```

## 许可证

[阿帕奇 - 2.0](https://npmcn.com/package/%40antelopejs/interface-auth/LICENSE)

## 常见问题

### @antelopejs/interface-auth 是什么？

用于令牌认证的羚羊JS接口:签名并验证令牌并给已核实的有效载荷注入API处理器

### 如何安装 @antelopejs/interface-auth？

在项目目录运行 npm install @antelopejs/interface-auth，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：@antelopejs/interface-api（\>=0\.0\.15 \<1\.0\.0）、@antelopejs/interface-core（\>=0\.2\.4 \<1\.0\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @antelopejs/interface-auth 支持 TypeScript 吗？

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

### @antelopejs/interface-auth 支持 ESM 还是 CommonJS？

以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。

### @antelopejs/interface-auth 可以商用吗？

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

### @antelopejs/interface-auth 的下载量有多少？

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

### @antelopejs/interface-auth 还在维护吗？

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