The API Platform Admin
API Platform Admin is a tool to automatically create a fancy (Material Design) and fully featured administration interface for any API supporting the Hydra Core Vocabulary, including but not limited to all APIs created using the API Platform framework.
The generated administration is a 100% standalone Single-Page-Application with no coupling to the server part, according to the API-first paradigm.
API Platform Admin parses the Hydra documentation then uses the awesome React Admin library (and React) to expose a nice, responsive, management interface (Create-Retrieve-Update-Delete) for all available resources.
You can also customize all screens by using React Admin components and even raw JavaScript/React code.
Features
- Automatically generate an admin interface for all the resources of the API thanks to hypermedia features of Hydra
- Generate list, create, show, edit screens as well as a delete button
- Generate suitable inputs and fields according to the API doc (e.g. number HTML input for numbers, checkbox for booleans, selectbox for relationships...)
- Generate suitable inputs and fields according to Schema.org types if available (e.g. email field for http://schema.org/email)
- Handle relationships
- Pagination support
- Automatically validate if a field is mandatory client-side according to the API description
- Send proper HTTP requests to the API and decode them using Hydra and JSON-LD formats
- Nicely display server-side errors (e.g. advanced validation)
- 100% customizable
The Distribution: Create Powerful APIs with Ease
The API Component
- General Design Considerations
- Configuration
- Overriding Default Order
- The Serialization Process
- Overall Process
- Available Serializers
- The Serialization Context, Groups and Relations
- Using Serialization Groups
- Using Serialization Groups per Operation
- Changing the Serialization Context Dynamically
- Changing the Serialization Context on a Per-item Basis
- Name Conversion
- Decorating a Serializer and Adding Extra Data
- Entity Identifier Case
- Embedding the JSON-LD Context
- The Event System
- Using External Vocabularies
- Extending JSON-LD context
- NelmioApiDocBundle Integration
The Schema Generator Component
- Configuration
- Customizing PHP Namespaces
- Forcing a Field Range
- Forcing a Field Cardinality
- Forcing a Relation Table Name
- Forcing (or Disabling) a Class Parent
- Forcing a Class to be Abstract
- Forcing a Nullable Property
- Forcing a Unique Property
- Making a Property Read Only
- Making a Property Write Only
- Forcing a Property to be in a Serialization Group
- Forcing an Embeddable Class to be Embedded
- Author PHPDoc
- Disabling Generators and Creating Custom Ones
- Skipping Accessor Method Generation
- Disabling the id Generator
- Generating UUIDs
- User submitted UUIDs
- Generating Custom IDs
- Disabling Usage of Doctrine Collection
- Changing the Field Visibility
- Generating @Assert\Type Annotations
- Forcing Doctrine Inheritance Mapping Annotation
- Interfaces and Doctrine Resolve Target Entity Listener
- Custom Schemas
- Checking GoodRelation Compatibility
- PHP File Header
- Full Configuration Reference
The Admin Component
The Client Generator Component
Deployment