# @antelopejs/interface-api 中文文档

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

版本：0\.3\.0
npm 元数据更新时间：2026-11-04T21:59:58.334Z
中文译文更新时间：2026-11-06T06:25:47.423Z
软件包许可：Apache-2\.0

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

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

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

- 包体积（解压后）：333 kB，88 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- 运行依赖：0 个
- peer 依赖：@antelopejs/interface-core \>=0\.4\.0 \<1\.0\.0
- 首次发布：2026-03-22T16:06:59.015Z
- 最新版本发布：2026-11-04T21:59:58.015Z
- 近 30 天下载量：16977（2026-10-06 至 2026-11-04，npm 官方下载统计）
- 已发布版本数：18（近 12 个月 18 个）

## 中文简介

HTTP和WebSocket API的羚羊JS接口:基于装饰器的控制器,路线和参数注入

## 安装

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

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

## README

# `@antelopejs/interface-api`

[![npm](https://img.shields.io/npm/v/@antelopejs/interface-api?style=for-the-badge&labelColor=000000&color=000000)](https://www.npmjs.com/package/@antelopejs/interface-api) [![License](https://img.shields.io/npm/l/@antelopejs/interface-api?style=for-the-badge&labelColor=000000&color=000000)](https://npmcn.com/package/%40antelopejs/interface-api/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/api)

HTTP和WebSocket API的羚羊JS接口. 您使用装饰器声明控制器和路由, 而执行接口的模块为它们服务 .

部分 [羚羊JS](https://github.com/AntelopeJS/antelopejs)用于 [羚羊JS 隐形物](https://github.com/AntelopeJS/dms),用于您的 PostgreSQL 、 MongoDB 或 RethinkDB 数据库的开源后台.

## 它提供的东西

-   `Controller` 财务报告和审定财务报表 `PartialController` 基道下的组路线,并有巢 `extend`。 。 。 .
-   `@Get`, (中文(简体) ), `@Post`, (中文(简体) ), `@Put`, (中文(简体) ), `@Delete`,以及 `@Route` 将方法映射到终点. `@Prefix`, (中文(简体) ), `@Postfix`,以及 `@Monitor` 在他们之前或之后运行.
-   `@Parameter`, (中文(简体) ), `@MultiParameter`, (中文(简体) ), `@JSONBody`, (中文(简体) ), `@RawBody`, (中文(简体) ), `@BodyStream`, (中文(简体) ), `@Context`, (中文(简体) ), `@Result`,以及 `@WriteStream` 将请求数据注入处理器参数. `@Transform` 在处理器收到前更改一个值.
-   `HTTPResult` 设定响应状态、标题和正文。 身体是个 `HTTPBody`,该字符串或值 `JSON.stringify` 写作JSON.
-   `@WebsocketHandler` 财务报告和审定财务报表 `@Connection` 在同一控制器上处理 WebSocket 连接.

## 执行情况

| 模块 | 页:1 |
| --- | --- |
| [`@antelopejs/api`](https://github.com/AntelopeJS/api) | HTTP 和 WebSocket 服务器, CORS 设置 |

## 安装

将接口添加到宣布路线的模块中 :

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

然后在项目中添加一个执行:

```bash
ajs project modules add @antelopejs/api
```

## 快开始

```ts
import {
  Controller,
  Get,
  HTTPResult,
  JSONBody,
  Parameter,
  Post,
} from "@antelopejs/interface-api";

export class BookController extends Controller("/books") {
  @Get(":id")
  async getBook(@Parameter("id") id: string) {
    return new HTTPResult(200, { id });
  }

  @Post("")
  async createBook(@JSONBody() body: { title: string }) {
    return new HTTPResult(201, body);
  }
}
```

装饰者在 JavaScript 定义类时对路由进行注册. `@antelopejs/api` 服务 `GET /books/:id` 财务报告和审定财务报表 `POST /books`。 。 。 .

## 文档

-   [导言](https://npmcn.com/package/%40antelopejs/interface-api/docs/1.introduction.md)
-   [主计长和路线登记](https://npmcn.com/package/%40antelopejs/interface-api/docs/2.controllers.md)
-   [HTTP 处理和操作](https://npmcn.com/package/%40antelopejs/interface-api/docs/3.http-handling.md)
-   [参数](https://npmcn.com/package/%40antelopejs/interface-api/docs/4.parameters.md)

## 兼容性

模块宣布此对等依赖 :

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

## 捐款

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

```bash
pnpm install
pnpm run checks
```

## 许可证

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

## 常见问题

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

HTTP和WebSocket API的羚羊JS接口:基于装饰器的控制器,路线和参数注入

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

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

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

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

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

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

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

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

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

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

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

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