The API Platform Admin
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 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 is a 100% standalone Single-Page-Application written in TypeScript with no coupling to the server part, according to the API-first paradigm.
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.
You can customize everything by using provided React Admin and MUI components, or by writing your custom React components.
Features
- Automatically generates an admin interface for all the resources of the API thanks to the hypermedia features of Hydra or to the OpenAPI documentationHydra のハイパーメディア機能または 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 descriptionAPI の説明に従って、フィールドがクライアント側で必須かどうかを自動的に検証します
- 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 MercureMercure によるリアルタイム更新をサポート
- All the features provided by React-admin can also be usedReact-admin が提供するすべての機能も使用できます
- 100% customizable100% カスタマイズ可能