@api-platform/create-client
v0.10.0
Published
Generate apps built with Next, Nuxt, Quasar, React, React Native, Vue or Vuetify for any API documented using Hydra or OpenAPI
Downloads
978
Keywords
Readme
API Platform Create Client
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.