| 1 | # API Platform Client Generator
|
| 2 |
|
| 3 | [](https://travis-ci.org/api-platform/client-generator)
|
| 4 | [](https://badge.fury.io/js/%40api-platform%2Fclient-generator)
|
| 5 |
|
| 6 | API Platform Client Generator is a generator to scaffold app with Create-Retrieve-Update-Delete features for any API exposing a [Hydra](http://www.hydra-cg.com/spec/latest/core/) or [OpenAPI](https://www.openapis.org/) documentation for:
|
| 7 |
|
| 8 | * Next.js
|
| 9 | * Nuxt.js
|
| 10 | * Quasar Framework
|
| 11 | * React/Redux
|
| 12 | * React Native
|
| 13 | * TypeScript Interfaces
|
| 14 | * Vue.js
|
| 15 | * Vuetify.js
|
| 16 |
|
| 17 | Works especially well with APIs built with the [API Platform](https://api-platform.com) framework.
|
| 18 |
|
| 19 | ## Documentation
|
| 20 |
|
| 21 | The documentation of API Platform's Client Generator can be browsed [on the official website](https://api-platform.com/docs/client-generator).
|
| 22 |
|
| 23 | ## Features
|
| 24 |
|
| 25 | * Generate high-quality TypeScript or ES6 components:
|
| 26 | * List view
|
| 27 | * Creation form
|
| 28 | * Editing form
|
| 29 | * Deletion button
|
| 30 | * Use the Hydra or OpenAPI documentations to generate the code
|
| 31 | * Generate the suitable HTML5 input type (`number`, `date`...) according to the type of the API property
|
| 32 | * Display of the server-side validation errors under the related input (if using API Platform Core)
|
| 33 | * Client-side validation (`required` attributes)
|
| 34 | * The generated HTML is compatible with [Bootstrap](https://getbootstrap.com/) and includes mandatory classes
|
| 35 | * The generated HTML code is accessible to people with disabilities ([ARIA](https://www.w3.org/WAI/intro/aria) support)
|
| 36 |
|
| 37 |
|
| 38 | ## Usage
|
| 39 |
|
| 40 | ### Hydra
|
| 41 |
|
| 42 | npx @api-platform/client-generator https://demo.api-platform.com/ output/ --resource Book
|
| 43 |
|
| 44 | ### OpenAPI v3 (experimental)
|
| 45 |
|
| 46 | npx @api-platform/client-generator https://demo.api-platform.com/docs.json?spec_version=3 output/ --resource Book --format openapi3
|
| 47 |
|
| 48 | ### OpenAPI v2 (formerly known as Swagger, deprecated)
|
| 49 |
|
| 50 | npx @api-platform/client-generator https://demo.api-platform.com/docs.json?spec_version=2 output/ --resource Book --format openapi2
|
| 51 |
|
| 52 | ## Credits
|
| 53 |
|
| 54 | Created by [Kévin Dunglas](https://dunglas.fr). Sponsored by [Les-Tilleuls.coop](https://les-tilleuls.coop).
|
| 55 | Commercial support available upon request.
|