{\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/ 目录.

目录

1. 用主机应用程序开发

   • 发动机
     • 安装
     • 使用量
   • 前端软件包
     • 安装
     • 构成部分
     • 其他职能

2. 出版指令

3. 剧作家助手

用主机应用程序开发

发动机

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

安装

1. 将此行添加到您的应用程序的 Gemfile 中 :

   source "NEETO_GEM_SERVER_URL" do
     # ..existing gems
   
     gem 'neeto-api-keys-engine'
   end
   

2. 执行 :

   bundle install
   

3. 将此行添加到您的应用程序 config/routes.rb 文件 :

   mount NeetoApiKeysEngine::Engine, at: "/neeto_api_keys"
   

4. 运行命令, 将所有需要从引擎到主机应用程序的迁移 :

   bundle exec rails neeto_api_keys_engine:install:migrations
   

5. 运行迁移.

   bundle exec rails db:migrate
   

6. 添加权限 neeto_api_keys_engine.manage_api_keys 给您的 permissions.yml 文档.

使用量

1. 添加 NeetoApiKeysEngine::ApiKeysHandler 对组织模式的关切.

   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 动作前方法 调用以认证必要的动作.

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 密钥 头曰. 对于不同的密钥或执行,请在 返回符号的控制器.

示例

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

前端软件包

安装

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

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

发展指示

检查 前端软件包开发指南 用于开发前端软件包的分步指令.

构成部分

ApiKeys(单位:千美元)源代码(中文(简体) )

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

道具

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

使用量

import React from "react";

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

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

export default App;

出版指令

咨询 构建和释放软件包 关于如何出版的详细指南.