# @antelopejs/dms-api 中文文档

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

版本：0\.6\.2
npm 元数据更新时间：2026-11-04T21:26:04.959Z
中文译文更新时间：2026-11-07T07:44:53.230Z
软件包许可：Apache-2\.0

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

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

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

- 包体积（解压后）：1.4 MB，361 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- 运行依赖：8 个
- 首次发布：2026-09-16T22:55:52.064Z
- 最新版本发布：2026-11-04T21:26:04.616Z
- 近 30 天下载量：2008（2026-10-06 至 2026-11-04，npm 官方下载统计）
- 已发布版本数：20（近 12 个月 20 个）

## 中文简介

AntelopeJS DMS的API控制台:API健康,请求日志,每道统计,推断合同和一个请求测试器.

## 安装

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

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

## README

# @ atelopejs/ dms- api (英语)

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

API 控制台 [羚羊JS 隐形物](https://github.com/AntelopeJS/dms):健康,请求日志,路由统计和一个测试器.

![The API Overview: health verdict, routes needing attention, slowest routes and error share](https://npmcn.com/package/%40antelopejs/dms-api/docs/images/overview.png)

## 它会做什么

-   告诉你的API是否健康,从何时起,为什么不健康,有流量,出错和最慢的路线.
-   以错误、 时间、 标题和正文( 大小封装和编辑) 来捕捉您项目路线的每一项请求 .
-   列出每一已登记的路线及其统计数字和根据代码和流量推断的合同.
-   发送内置测试器的测试请求,除真实流量外登录.
-   应用其设置(被监视的路径,保留,被捕获的头条,慢阈值)而无需重启.

这是您 API 的仪表板, 而不是 HTTP 服务器 : 此工程需要 API 提供者, 如 `@antelopejs/api`。 。 。 .

## 安装

从已加载的工程根端运行 AtelopeJS CLI `@antelopejs/dms`数字 :

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

## 快开始

该模块在工作时没有配置. 重新打开后端, 然后打开前端 **模块 — API** (单位:千美元)`/modules/api`) (中文(简体) ). 评议 [配置](https://dms.antelopejs.com/docs/modules/api/configuration) 在获取真实流量之前:请求日志可以持有应用程序数据.

为了尝试样本流量,克隆这个寄存器并运行它的游乐场:

```bash
pnpm install && pnpm dev          # backend
pnpm frontend:dev                 # dashboard, in a second terminal
pnpm --dir playground traffic     # a few hundred demo requests
```

[模板- dms- 演示](https://github.com/AntelopeJS/template-dms-demo) 还装入模块.

## 兼容性

| 软件包 | 支助 | 测试过 |
| --- | --- | --- |
| `@antelopejs/interface-api` | `>=0.2.0 <1.0.0` | `0.2.0` |
| `@antelopejs/interface-api-util` | `>=0.3.0 <1.0.0` | `0.3.0` |
| `@antelopejs/interface-core` | `>=0.4.0 <1.0.0` | `0.4.0` |
| `@antelopejs/interface-database` | `>=0.3.0 <1.0.0` | `0.3.0` |
| `@antelopejs/interface-database-decorators` | `>=0.2.0 <1.0.0` | `0.2.0` |
| `@antelopejs/interface-dms` | `>=0.12.0 <1.0.0` | `0.12.0` |
| `@antelopejs/interface-dms-automation` | `>=0.6.0 <1.0.0` | `0.6.0` |

模块还需要一个执行 `@antelopejs/interface-dms` 区域及 `@antelopejs/dms-frontend` 区域中的渲染器,其前端模块宣布在 `engines["@antelopejs/dms-frontend"]` 联 合 国 `frontend-vue/package.json`; 数据 `ajs dms` CLI拒绝用这个范围以外的渲染器来建造. 它运行在这些提供者:

-   API 提供者 : `@antelopejs/api`。 。 。 .
-   数据库:a `@antelopejs/interface-database` 执行,例如: `@antelopejs/mongodb`。 。 。 .

从0.1升级? 读取 [财务问题](https://dms.antelopejs.com/docs/modules/api/faq#upgrading-from-01)。 。 。 .

## 文档

-   [导言](https://dms.antelopejs.com/docs/modules/api/introduction)
-   [安装](https://dms.antelopejs.com/docs/modules/api/installation)
-   [配置](https://dms.antelopejs.com/docs/modules/api/configuration)
-   [使用量](https://dms.antelopejs.com/docs/modules/api/usage/overview)
-   [扩展](https://dms.antelopejs.com/docs/modules/api/extending)
-   [财务问题](https://dms.antelopejs.com/docs/modules/api/faq)

向导的消息来源 [`docs/`](https://npmcn.com/package/%40antelopejs/dms-api/docs)包件还装有 `dms-api` Claude代码技巧 [`skills/`](https://npmcn.com/package/%40antelopejs/dms-api/skills),在 `antelopeJs.skills`。 。 。 .

## 捐款

读取 [捐款额](https://npmcn.com/package/%40antelopejs/dms-api/CONTRIBUTING.md) 在打开拉出请求之前。 使用在 `package.json`。游乐场与MongoDB连接,地点: `mongodb://localhost:27017` 除非 `MONGO_URL` 指别处.

一个root安装包括后端并被运出Vue模块,保留了各自独立的锁文件. 游乐场保持独立:运行 `pnpm --dir playground install --ignore-workspace --frozen-lockfile` 开始之前 使用下面的根脚本而不是递归脚本: 前端 `build` 财务报告和审定财务报表 `typecheck` 需要游乐场或生成的 Inertia 工作空间, 并且根检已经委托给 Vue 模块 .

```bash
pnpm install
pnpm dev            # playground backend
pnpm frontend:dev   # dashboard, in a second terminal
pnpm lint
pnpm typecheck
pnpm test           # backend unit tests (tests/), then the frontend suite
pnpm knip
```

仓库说明

-   以已安装的地址管理系统构建和排入前端模块, 运行 `pnpm exec ajs dms verify-source -m ../frontend-vue` 从 `playground/`,或设置 `DMS_FRONTEND_WORKSPACE` 到工作空间 `ajs dms prepare` 运行 `pnpm --dir frontend-vue typecheck`。 。 。 .

## 许可证

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

## 常见问题

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

AntelopeJS DMS的API控制台:API健康,请求日志,每道统计,推断合同和一个请求测试器\.

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

在项目目录运行 npm install @antelopejs/dms-api，或使用 pnpm add / yarn add / bun add。

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

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

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

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

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

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

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

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

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

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