The API Platform Admin

Screencast

API Platform Admin is a tool to automatically create a beautiful (Material Design) and fully-featured administration interface for any API supporting the Hydra Core Vocabulary, exposing an OpenAPI documentation or other API specification formats supported by @api-platform/api-doc-parser.

API Platform Admin は、Hydra Core Vocabulary をサポートする任意の API 用に美しい (マテリアル デザイン) で完全な機能を備えた管理インターフェイスを自動的に作成し、@api-platform/api-doc-parser でサポートされている OpenAPI ドキュメントまたはその他の API 仕様形式を公開するツールです。

API Platform Admin is the perfect companion of APIs created using the API Platform framework, but also supports APIs written with any other programming language or framework as long as they expose a standard Hydra API documentation or an OpenAPI documentation.

API Platform Admin は、API Platform フレームワークを使用して作成された API の完璧なコンパニオンですが、標準の Hydra API ドキュメントまたは OpenAPI ドキュメントを公開している限り、他のプログラミング言語またはフレームワークで記述された API もサポートします。

API Platform Admin is a 100% standalone Single-Page-Application written in TypeScript with no coupling to the server part, according to the API-first paradigm.

API プラットフォーム管理者は、API ファーストのパラダイムに従って、サーバー部分に結合されていない、TypeScript で記述された 100% スタンドアロンの単一ページ アプリケーションです。

API Platform Admin parses the API documentation then uses the awesome React Admin library to expose a nice, responsive, management interface (Create-Retrieve-Update-Delete) for all documented resource types.

API プラットフォーム管理者は API ドキュメントを解析し、すばらしい React Adminlibrary を使用して、ドキュメント化されたすべてのリソース タイプの優れた応答性の高い管理インターフェイス (Create-Retrieve-Update-Delete) を公開します。

You can customize everything by using provided React Admin and MUI components, or by writing your custom React components.

提供されている React Admin および MUI コンポーネントを使用するか、カスタム React コンポーネントを作成することで、すべてをカスタマイズできます。

Features

  • Automatically generates an admin interface for all the resources of the API thanks to the hypermedia features of Hydra or to the OpenAPI documentation
    Hydra のハイパーメディア機能または OpenAPI ドキュメントのおかげで、API のすべてのリソースの管理インターフェイスを自動的に生成します。
  • Generates 'list', 'create', 'show', and 'edit' screens, as well as a delete button
    「リスト」、「作成」、「表示」、「編集」画面、および削除ボタンを生成します
  • Generates suitable inputs and fields according to the API doc (e.g. number HTML input for numbers, checkbox for booleans, selectbox for relationships...)
    API ドキュメントに従って適切な入力とフィールドを生成します (例: 数値の数値 HTML 入力、ブール値のチェックボックス、関係の選択ボックス...)
  • Generates suitable inputs and fields according to Schema.org types if available (e.g. email field for https://schema.org/email)
    可能な場合、Schema.org のタイプに従って適切な入力とフィールドを生成します (例: https://schema.org/email の電子メール フィールド)。
  • Handles relationships
    関係を処理します
  • Supports pagination
    ページネーションをサポート
  • Supports filters and ordering
    フィルターと順序付けをサポート
  • Automatically validates whether a field is mandatory client-side according to the API description
    API の説明に従って、フィールドがクライアント側で必須かどうかを自動的に検証します
  • Sends proper HTTP requests to the API and decodes them using Hydra and JSON-LD formats if available
    適切な HTTP リクエストを API に送信し、利用可能な場合は Hydra および JSON-LD 形式を使用してデコードします
  • Nicely displays server-side errors (e.g. advanced validation)
    サーバー側のエラーを適切に表示します (例: 高度な検証)
  • Supports real-time updates with Mercure
    Mercure によるリアルタイム更新をサポート
  • All the features provided by React-admin can also be used
    React-admin が提供するすべての機能も使用できます
  • 100% customizable
    100% カスタマイズ可能