Skip to content

Generate React or Vue.js-based Progressive Web Apps from an Hydra-enabled API. Also support React Native.

License

Notifications You must be signed in to change notification settings

Gregcop1/client-generator

 
 

Repository files navigation

API Platform Client Generator

Build Status npm version MIT Licence

API Platform Client Generator is a generator to scaffold app with Create-Retrieve-Update-Delete features for any API exposing a Hydra or Swagger documentation for:

  • React/Redux
  • React Native
  • Vue.js

Works especially well with APIs built with the API Platform framework.

Installation

yarn global add @api-platform/client-generator

Usage

Hydra

generate-api-platform-client https://demo.api-platform.com/ output/ --resource Book

OpenAPI (experimental)

generate-api-platform-client https://demo.api-platform.com/docs.json output/ --resource Book --format swagger

Features

  • Generate high-quality ES6 components and files built with React, Redux, React Router and Redux Form including:
    • A list view
    • A creation form
    • An edition form
    • A deletion button
  • Use the Hydra or Swagger API documentation to generate the code
  • Generate the suitable HTML5 input type (number, date...) according to the type of the API property
  • Display of the server-side validation errors under the related input (if using API Platform Core)
  • Client-side validation (required attributes)
  • The generated HTML is compatible with Bootstrap and include mandatory classes
  • The generated HTML code is accessible to people with disabilities (ARIA support)
  • The Redux and the React Router configuration is also generated

Documentation

The documentation of API Platform's Client Generator can be browsed on the official website.

Credits

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

About

Generate React or Vue.js-based Progressive Web Apps from an Hydra-enabled API. Also support React Native.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 85.7%
  • Vue 14.0%
  • TypeScript 0.3%