# @bigbinary/neeto-api-keys-frontend 中文文档

规范地址：https://npmcn.com/package/%40bigbinary/neeto-api-keys-frontend/

版本：3\.2\.0
npm 元数据更新时间：2026-11-03T06:31:49.055Z
中文译文更新时间：2026-11-08T01:58:25.725Z
软件包许可：UNLICENSED

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

原始 npm 页面：https://www.npmjs.com/package/%40bigbinary/neeto-api-keys-frontend
原文对照：https://npmcn.com/package/%40bigbinary/neeto-api-keys-frontend/?lang=original
项目主页：https://github.com/bigbinary/neeto-api-keys-nano

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

- 包体积（解压后）：607 kB，72 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- Node.js 要求：\>=18\.12
- 运行依赖：0 个
- peer 依赖：qs 6\.16\.2，url 0\.11\.4，yup 0\.32\.11，antd 5\.22\.1，util ^0\.12\.5，dayjs 1\.11\.10，ramda 0\.29\.0，react 18\.3\.1，buffer ^6\.0\.3，formik 2\.4\.6，i18next 22\.5\.1，zustand 4\.4\.2，dompurify 3\.4\.17，js-logger 1\.6\.1，react-dom 18\.3\.1，classnames 2\.5\.1，stream-http 3\.2\.0，tailwindcss 3\.4\.14，lucide-react 0\.577\.0，react-helmet ^6\.1\.0，os-browserify 0\.3\.0，react-i18next 12\.3\.1，vm-browserify 1\.1\.2，@babel/runtime 7\.29\.7，react-toastify 8\.0\.2，tty-browserify 0\.0\.1，path-browserify ^1\.0\.1，https-browserify 1\.0\.0，mixpanel-browser ^2\.45\.0，react-router-dom 5\.3\.3，crypto-browserify 3\.12\.1，source-map-loader 4\.0\.1，stream-browserify ^3\.0\.0，@bigbinary/neetoui 8\.8\.3，@honeybadger-io/js 6\.10\.1，@bigbinary/neeto-cist 1\.0\.17，@honeybadger-io/react 6\.1\.25，@tanstack/react-query 5\.59\.20，@bigbinary/neeto-atoms 1\.1\.2，@bigbinary/neeto-icons 1\.20\.89，@bigbinary/neeto-molecules 5\.9\.15，@tailwindcss/container-queries ^0\.1\.1，@tanstack/react-query-devtools 5\.59\.20，@bigbinary/neeto-commons-frontend 4\.14\.8，@bigbinary/neeto-filters-frontend 4\.6\.3
- 首次发布：2023-09-26T15:46:02.801Z
- 最新版本发布：2026-11-03T06:31:48.865Z
- 近 30 天下载量：36298（2026-10-08 至 2026-11-06，npm 官方下载统计）
- 已发布版本数：112（近 12 个月 53 个）

## 中文简介

一个回波作为新纳米结构,配置,数据等的真理来源.

## 安装

```sh
npm install @bigbinary/neeto-api-keys-frontend
```

也可以使用：`pnpm add @bigbinary/neeto-api-keys-frontend`、`yarn add @bigbinary/neeto-api-keys-frontend`、`bun add @bigbinary/neeto-api-keys-frontend`

## README

# {\\fn黑体\\fs22\\bord1\\shad0\\3ahbe\\4ah00\\fscx67\\fscy66\\2chffffff\\3ch808080}我必须..

这个 `neeto-api-keys-nano` 便利管理 API 密钥 需要申请。 纳米出口 `@bigbinary/neeto-api-keys-frontend` 国家防范机制一揽子计划 `neeto-api-keys-engine` 铁路发展引擎. 内容 API- key Playwright 帮助器独立发布为 `@bigbinary/neeto-api-keys-playwright` 从 [`playwright/`](https://npmcn.com/package/%40bigbinary/neeto-api-keys-frontend/playwright/README.md) 目录.

# 目录

1.  [用主机应用程序开发](https://npmcn.com/package/%40bigbinary/neeto-api-keys-frontend/#readme-development-with-host-application)
    
    -   [发动机](https://npmcn.com/package/%40bigbinary/neeto-api-keys-frontend/#readme-engine)
        -   [安装](https://npmcn.com/package/%40bigbinary/neeto-api-keys-frontend/#readme-installation)
        -   [使用量](https://npmcn.com/package/%40bigbinary/neeto-api-keys-frontend/#readme-usage)
    -   [前端软件包](https://npmcn.com/package/%40bigbinary/neeto-api-keys-frontend/#readme-frontend-package)
        -   [安装](https://npmcn.com/package/%40bigbinary/neeto-api-keys-frontend/#readme-installation-1)
        -   [构成部分](https://npmcn.com/package/%40bigbinary/neeto-api-keys-frontend/#readme-components)
        -   [其他职能](https://npmcn.com/package/%40bigbinary/neeto-api-keys-frontend/#readme-other-functions)
2.  [出版指令](https://npmcn.com/package/%40bigbinary/neeto-api-keys-frontend/#readme-instructions-for-publishing)
    
3.  [剧作家助手](https://npmcn.com/package/%40bigbinary/neeto-api-keys-frontend/playwright/README.md)
    

# 用主机应用程序开发

## 发动机

该引擎用于管理横跨neto产品的API密钥. 它还规定: 处理与 `NeetoApiKeysEngine::ApiKey` 型号.

### 安装

1.  将此行添加到您的应用程序的 Gemfile 中 :
    
    ```ruby
    source "NEETO_GEM_SERVER_URL" do
      # ..existing gems
    
      gem 'neeto-api-keys-engine'
    end
    ```
    
2.  执行 :
    
    ```shell
    bundle install
    ```
    
3.  将此行添加到您的应用程序 `config/routes.rb` 文件 :
    
    ```ruby
    mount NeetoApiKeysEngine::Engine, at: "/neeto_api_keys"
    ```
    
4.  运行命令, 将所有需要从引擎到主机应用程序的迁移 :
    
    ```shell
    bundle exec rails neeto_api_keys_engine:install:migrations
    ```
    
5.  运行迁移.
    
    ```shell
    bundle exec rails db:migrate
    ```
    
6.  添加权限 `neeto_api_keys_engine.manage_api_keys` 给您的 `permissions.yml` 文档.
    

### 使用量

1.  添加 `NeetoApiKeysEngine::ApiKeysHandler` 对组织模式的关切.
    
    ```ruby
    class Organization < ActiveRecord::Base
      # Include the following concern
      include NeetoApiKeysEngine::ApiKeysHandler
    ```
    
    这个 `NeetoApiKeysEngine::ApiKeysHandler` 关注是一个模块,提供 与主机应用程序中的 API 密钥相关的功能。 它确立了 与 API 密钥合作的关联、方法和逻辑.
    
2.  添加数据 `NeetoApiKeysEngine::Authenticatable` 对控制者的关切 需要 API 密钥认证。 利用 `neeto_api_keys_authenticate_using_api_key` 动作前方法 调用以认证必要的动作.
    

```ruby
class Api::V1::PublicApiController < ActionController::Base
  # Include the following concern and callback
  include NeetoApiKeysEngine::Authenticatable

  before_action :neeto_api_keys_authenticate_using_api_key
```

默认情况下, 这种方法预计在 X- Api- Key 密钥中的 API 密钥 头曰. 对于不同的密钥或执行,请在 返回符号的控制器.

示例

```ruby
def token
  request.headers["neeto-Api-Key"]
end
```

## 前端软件包

### 安装

安装最新的 `NeetoApiKeysNano` 使用下列命令的软件包:

```shell
yarn add @bigbinary/neeto-api-keys-frontend
```

### 发展指示

检查 [前端软件包开发指南](https://neeto-engineering.neetokb.com/p/a-d34cb4b0) 用于开发前端软件包的分步指令.

### 构成部分

#### `ApiKeys`(单位:千美元)[源代码](https://github.com/bigbinary/neeto-api-keys-nano/blob/2013bab9779ade1e56196ec6f258329fdf768e30/app/javascript/src/components/ApiKeys/index.jsx)(中文(简体) )

此组件用于在网络应用程序中管理 API 密钥 。 它规定 用于查看、创建、更新和删除 API 密钥的功能。 这个 组件包括用于显示 API 关键数据的表格,以及用于 添加新密钥,编辑已存在的密钥并删除密钥。 还有一个搜索栏 以方便找到特定的 API 密钥.

##### 道具

-   `noDataProps`: 当没有数据可以显示时处理情景的道具.
-   `headerProps`: 配置组件头部部分的道具.
-   `titleHelpPopoverProps`: 标题中配置帮助弹出器的道具 节.
-   `zapierIntegrableType` : 如果主机应用程序有 Zapier 集成, 表格 将显示 Zapier 密钥, 只有在“ 组织 ” 时。 这个 道具 **需要时间** 如果可合并类型不是“组织”而是“组织” 潜入另一个实体.
-   `helpDocUrl`: 支持发送产品帮助文章的通路.

##### 使用量

```jsx
import React from "react";

import { ApiKeys } from "@bigbinary/neeto-api-keys-frontend";

const App = () => <ApiKeys />;

export default App;
```

# 出版指令

咨询 [构建和释放软件包](https://neeto-engineering.neetokb.com/articles/building-and-releasing-packages) 关于如何出版的详细指南.

## 常见问题

### @bigbinary/neeto-api-keys-frontend 是什么？

一个回波作为新纳米结构,配置,数据等的真理来源\.

### 如何安装 @bigbinary/neeto-api-keys-frontend？

在项目目录运行 npm install @bigbinary/neeto-api-keys-frontend，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：qs（6\.16\.2）、url（0\.11\.4）、yup（0\.32\.11）、antd（5\.22\.1）、util（^0\.12\.5）、dayjs（1\.11\.10）、ramda（0\.29\.0）、react（18\.3\.1）、buffer（^6\.0\.3）、formik（2\.4\.6）、i18next（22\.5\.1）、zustand（4\.4\.2）、dompurify（3\.4\.17）、js-logger（1\.6\.1）、react-dom（18\.3\.1）、classnames（2\.5\.1）、stream-http（3\.2\.0）、tailwindcss（3\.4\.14）、lucide-react（0\.577\.0）、react-helmet（^6\.1\.0）、os-browserify（0\.3\.0）、react-i18next（12\.3\.1）、vm-browserify（1\.1\.2）、@babel/runtime（7\.29\.7）、react-toastify（8\.0\.2）、tty-browserify（0\.0\.1）、path-browserify（^1\.0\.1）、https-browserify（1\.0\.0）、mixpanel-browser（^2\.45\.0）、react-router-dom（5\.3\.3）、crypto-browserify（3\.12\.1）、source-map-loader（4\.0\.1）、stream-browserify（^3\.0\.0）、@bigbinary/neetoui（8\.8\.3）、@honeybadger-io/js（6\.10\.1）、@bigbinary/neeto-cist（1\.0\.17）、@honeybadger-io/react（6\.1\.25）、@tanstack/react-query（5\.59\.20）、@bigbinary/neeto-atoms（1\.1\.2）、@bigbinary/neeto-icons（1\.20\.89）、@bigbinary/neeto-molecules（5\.9\.15）、@tailwindcss/container-queries（^0\.1\.1）、@tanstack/react-query-devtools（5\.59\.20）、@bigbinary/neeto-commons-frontend（4\.14\.8）、@bigbinary/neeto-filters-frontend（4\.6\.3）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @bigbinary/neeto-api-keys-frontend 支持 TypeScript 吗？

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

### @bigbinary/neeto-api-keys-frontend 支持 ESM 还是 CommonJS？

同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。

### @bigbinary/neeto-api-keys-frontend 需要什么版本的 Node\.js？

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

### @bigbinary/neeto-api-keys-frontend 可以商用吗？

@bigbinary/neeto-api-keys-frontend 使用 UNLICENSED 许可。作者声明为 UNLICENSED，即不授予公开使用许可（与公共领域的 Unlicense 不同）。使用前需获得作者授权。以上为概括，不构成法律意见，请以许可原文为准。

### @bigbinary/neeto-api-keys-frontend 的下载量有多少？

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

### @bigbinary/neeto-api-keys-frontend 还在维护吗？

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