GithubHelp home page GithubHelp logo

dinhthaimanh / create-client Goto Github PK

View Code? Open in Web Editor NEW

This project forked from api-platform/create-client

0.0 0.0 0.0 1.77 MB

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

Home Page: https://api-platform.com/docs/client-generator/

License: MIT License

Shell 0.94% JavaScript 25.93% TypeScript 40.04% CSS 0.02% Vue 33.06%

create-client's Introduction

API Platform Create Client

GitHub Actions npm version

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

  • Next.js
  • Nuxt
  • Quasar
  • React
  • React Native
  • TypeScript Interfaces
  • Vue.js
  • Vuetify.js

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

Documentation

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

Features

  • Generate high-quality TypeScript or ES6 components:
    • List view
    • Creation form
    • Editing form
    • Deletion button
  • Use the Hydra or OpenAPI documentation to generate the code
  • Generate the suitable 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 includes mandatory classes
  • The generated HTML code is accessible to people with disabilities (ARIA support)
  • Bring your own templates

Usage

Hydra

npm init @api-platform/client https://demo.api-platform.com/ output/ --resource Book

OpenAPI 3

npm init @api-platform/client https://demo.api-platform.com/docs.json output/ --resource Book --format openapi3

Credits

Created by Kévin Dunglas.

Sponsored by Les-Tilleuls.coop.

Commercial support is available upon request.

create-client's People

Contributors

alanpoulain avatar aloneh avatar artandor avatar bolid1 avatar dependabot-preview[bot] avatar dependabot[bot] avatar devel-pa avatar dunglas avatar electricbonfire avatar fabious avatar gregcop1 avatar jamesgeorge007 avatar jmontoyaa avatar justinezahiri avatar kuznetsovsite avatar luca-nardelli avatar malikalahfaoui avatar matyo91 avatar mbrodala avatar meyerbaptiste avatar mysiar avatar pierre-h avatar potik1 avatar sebheitzmann avatar sh41 avatar shywim avatar soyuka avatar toofff avatar valentincrochemore avatar weaverryan 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.