API 平台管理员

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

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

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

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

演示

点击这里 用于在现场测试 API 平台管理员.

演示的源代码可用 在此寄存器中。 。 。 .

安装

yarn add @api-platform/admin

使用量

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'));

或者说:

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 格式解码
• 很好的显示服务器侧出错( 如高级验证)
• 支持实时更新 信使
• 所有的东西 react-admin 提供的特性 也可以使用
• 100%可定制

文档

API 平台管理员的文档可以浏览 官方网站(简体中文)。 。 。 .

还检查 React-admin 的文档 在他们的官方网站上。 。 。 .

贷项

创建于 凯文·邓格拉斯发起人: 莱-蒂勒斯.coop。 。 。 . 应请求提供商业支助.