# @api-platform/admin 中文文档

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

版本：4\.0\.9
npm 元数据更新时间：2026-02-27T14:41:06.860Z
中文译文更新时间：2026-11-06T09:52:10.106Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：701 kB，321 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：4 个
- peer 依赖：react \*，react-dom \*
- 首次发布：2017-09-15T15:16:40.605Z
- 最新版本发布：2026-02-27T14:41:06.383Z
- 近 30 天下载量：23811（2026-10-06 至 2026-11-04，npm 官方下载统计）
- 已发布版本数：101（近 12 个月 2 个）

## 中文简介

Hydra-United API的自动管理接口.

## 安装

```sh
npm install @api-platform/admin
```

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

## README

# API 平台管理员

[![GitHub Actions](https://github.com/api-platform/admin/workflows/CI/badge.svg?branch=main)](https://github.com/api-platform/admin/actions?query=workflow%3ACI+branch%3Amain) [![npm version](https://badge.fury.io/js/%40api-platform%2Fadmin.svg)](https://badge.fury.io/js/%40api-platform%2Fadmin)

API 平台管理器是自动创建美丽(Matrial Design)和全功能管理界面的工具 对于任何 API 支持 [海德拉核心词汇表](http://www.hydra-cg.com/) 或揭露 [OpenAPI 文档](https://www.openapis.org/), (中文(简体) ), 包括但不仅限于使用 [aPI 平台框架](https://api-platform.com/)。 。 。 .

![Demo of API Platform Admin in action](https://api-platform.com/97cd2738071d63989db0bbcb6ba85a25/admin-demo.gif)

生成的管理器是100%的独立单页应用程序,没有连接到服务器部分 到API的第一个范式.

API 平台管理员 剖析 Hydra 或 OpenAPI 文档, 然后使用 awers [反应admin](https://marmelab.com/react-admin/) 图书馆(和 [反应](https://facebook.github.io/react/)),以曝光一个很好的,反应灵敏的管理界面(Create-Retriev-Update-Delete) 所有可用资源.

也可以通过使用React-admin组件甚至原始JavaScript/React代码来自定义所有屏幕.

## 演示

[点击这里](https://demo.api-platform.com/admin) 用于在现场测试 API 平台管理员.

演示的源代码可用 [在此寄存器中](https://github.com/api-platform/demo)。 。 。 .

## 安装

```
yarn add @api-platform/admin
```

## 使用量

```javascript
import React from 'react';
import ReactDOM from 'react-dom';
import { HydraAdmin, OpenApiAdmin } from '@api-platform/admin';

// To use Hydra:
const Admin = () => <HydraAdmin entrypoint="https://demo.api-platform.com" />; // Replace with your own API entrypoint
// To use OpenAPI (with a very simple REST data provider):
const Admin = () => <OpenApiAdmin
  docEntrypoint="https://demo.api-platform.com/docs.json" // Replace with your own OpenAPI documentation entrypoint
  entrypoint="https://demo.api-platform.com" // Replace with your own API entrypoint
/>;

ReactDOM.render(<Admin />, document.getElementById('root'));
```

或者说:

```javascript
import React from 'react';
import ReactDOM from 'react-dom';
import {
  AdminGuesser,
  hydraDataProvider,
  hydraSchemaAnalyzer,
  openApiDataProvider,
  openApiSchemaAnalyzer
} from '@api-platform/admin';
import simpleRestProvider from 'ra-data-simple-rest';

// Use your custom data provider or resource schema analyzer
// Hydra:
const dataProvider = hydraDataProvider({ entrypoint: 'https://demo.api-platform.com' });
const schemaAnalyzer = hydraSchemaAnalyzer();
// OpenAPI:
const dataProvider = openApiDataProvider({
  // Use any data provider you like
  dataProvider: simpleRestProvider('https://demo.api-platform.com'),
  entrypoint: 'https://demo.api-platform.com',
  docEntrypoint: 'https://demo.api-platform.com/docs.json',
});
const schemaAnalyzer = openApiSchemaAnalyzer();

const Admin = () => (
  <AdminGuesser
    dataProvider={dataProvider}
    schemaAnalyzer={schemaAnalyzer}
  />
);

ReactDOM.render(<Admin />, document.getElementById('root'));
```

## 特征

-   由于 Hydra 的超媒体特性或 OpenAPI 文档, 自动生成对 API 全部资源的管理界面
-   生成“ 列表”、“ 创建”、“ 显示” 和“ 编辑” 屏幕以及删除按钮
-   根据 API doc 生成合适的输入和字段(例如数字的 HTML 输入,布尔语的复选框,关系的选择框...)
-   根据 Schema.org 类型生成合适的输入和字段(例如: `http://schema.org/email`(中文(简体) )
-   处理关系
-   支持页化
-   支持过滤和排序
-   根据 API 描述自动验证一个字段是否为强制客户端
-   向 API 发送适当的 HTTP 请求, 并使用 Hydra 和 JSON- LD 格式解码
-   很好的显示服务器侧出错( 如高级验证)
-   支持实时更新 [信使](https://mercure.rocks/)
-   所有的东西 [react-admin 提供的特性](https://marmelab.com/react-admin/Tutorial.html) 也可以使用
-   **100%可定制**

## 文档

API 平台管理员的文档可以浏览 [官方网站(简体中文)](https://api-platform.com/docs/admin/)。 。 。 .

还检查 React-admin 的文档 [在他们的官方网站上](https://marmelab.com/react-admin/Tutorial.html)。 。 。 .

## 贷项

创建于 [凯文·邓格拉斯](https://dunglas.fr/)发起人: [莱-蒂勒斯.coop](https://les-tilleuls.coop/)。 。 。 . 应请求提供商业支助.

## 常见问题

### @api-platform/admin 是什么？

Hydra-United API的自动管理接口\.

### 如何安装 @api-platform/admin？

在项目目录运行 npm install @api-platform/admin，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：react（\*）、react-dom（\*）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @api-platform/admin 支持 TypeScript 吗？

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

### @api-platform/admin 支持 ESM 还是 CommonJS？

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

### @api-platform/admin 可以商用吗？

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

### @api-platform/admin 的下载量有多少？

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

### @api-platform/admin 还在维护吗？

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