v3.1 The API Platform Admin

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 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.

React Admin Screencast
Watch the React Admin screencast

# 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
  • 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…)
  • Generates suitable inputs and fields according to Schema.org types if available (e.g. email field for 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
  • Sends proper HTTP requests to the API and decodes them using Hydra and JSON-LD formats if available
  • Nicely displays server-side errors (e.g. advanced validation)
  • Supports real-time updates with Mercure
  • All the features provided by React-admin can also be used
  • 100% customizable

You can also help us improve the documentation of this page.

Made with love by

Les-Tilleuls.coop can help you design and develop your APIs and web projects, and train your teams in API Platform, Symfony, Next.js, Kubernetes and a wide range of other technologies.

Learn more

Copyright © 2023 Kévin Dunglas

Sponsored by Les-Tilleuls.coop