api-platform/admin

Name: admin

Owner: API Platform

Description: A fancy and fully-featured administration interface builder written in ReactJS supporting APIs documented using Hydra (including all APIs built with API Platform)

Created: 2015-11-30 13:29:22.0

Updated: 2018-05-23 06:22:27.0

Pushed: 2018-04-27 19:38:13.0

Homepage: https://api-platform.com/docs/admin/

Size: 405

Language: JavaScript

GitHub Committers

User	Most Recent Commit	# Commits

Other Committers

User	Email	Most Recent Commit	# Commits

README

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 Admin On Rest 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 Admin On Rest components and even raw JavaScript/React code.

Installation

yarn add @api-platform/admin

Usage

rt React, { Component } from 'react';
rt { HydraAdmin } from '@api-platform/admin';

s App extends Component {
nder() {
return <HydraAdmin entrypoint="https://demo.api-platform.com"/> // Replace with your own API entrypoint



rt default App;

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

Documentation

The documentation of API Platform Admin can be browsed on the official website.

Credits

Created by Kévin Dunglas. Sponsored by Les-Tilleuls.coop. Commercial support available upon request.