Giter VIP home page Giter VIP logo

admin's Introduction

API Platform Admin

Build Status npm version

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, including but not limited to all APIs created using the API Platform framework.

Demo of API Platform Admin in action

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 Hydra or OpenAPI documentations, 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.

Installation

yarn add @api-platform/admin

Usage

import React from 'react';
import ReactDOM from 'react-dom';
import { HydraAdmin } from '@api-platform/admin';

const Admin = () => <HydraAdmin entrypoint="https://demo.api-platform.com" />; // Replace with your own API entrypoint

ReactDOM.render(<Admin />, document.getElementById('root'));

Or alternatively:

import React from 'react';
import ReactDOM from 'react-dom';
import {
  AdminGuesser,
  hydraDataProvider,
  hydraSchemaAnalyzer,
} from '@api-platform/admin';

const Admin = () => (
  <AdminGuesser
    // Use your custom data provider or resource schema analyzer
    dataProvider={hydraDataProvider('https://demo.api-platform.com')}
    schemaAnalyzer={hydraSchemaAnalyzer()}
  />
);

ReactDOM.render(<Admin />, document.getElementById('root'));

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.

admin's People

Contributors

alanpoulain avatar alexisjanvier avatar andytson-inviqa avatar arnaudoisel avatar clairecoloma avatar comxd avatar dependabot-preview[bot] avatar djhi avatar dunglas avatar fabious avatar ginifizz avatar jbeurel avatar jfthuillier avatar johnstyle avatar k911 avatar konovalovdv avatar lutangar avatar marcw avatar mauchede avatar meyerbaptiste avatar mysiar avatar olcina avatar quentinus95 avatar silvia-odwyer avatar simperfit avatar souriya-les-tilleuls avatar soyuka avatar sumitkharche avatar tienvx avatar toofff avatar

Stargazers

 avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.