README

API Platform is a next-generation web framework designed to easily create API-first projects without compromising extensibility and flexibility:

• Design your own data model as plain old PHP classes or import an existing ontology.
• Expose in minutes a hypermedia REST or a GraphQL API with pagination, data validation, access control, relation embedding, filters, and error handling...
• Benefit from Content Negotiation: GraphQL, JSON-LD, Hydra, HAL, JSON:API, YAML, JSON, XML and CSV are supported out of the box.
• Enjoy the beautiful automatically generated API documentation (OpenAPI).
• Add a convenient Material Design administration interface built with React without writing a line of code.
• Scaffold fully functional Progressive-Web-Apps and mobile apps built with Next.js (React), Nuxt.js (Vue.js) or React Native thanks to the client generator (a Vue.js generator is also available).
• Install a development environment and deploy your project in production using Docker and Kubernetes.
• Easily add OAuth authentication.
• Create specs and tests with a developer friendly API testing tool.

The official project documentation is available on the API Platform website.

API Platform embraces open web standards and the Linked Data movement. Your API will automatically expose structured data. It means that your API Platform application is usable out of the box with technologies of the semantic web.

It also means that your SEO will be improved because Google leverages these formats.

Last but not least, the server component of API Platform is built on top of the Symfony framework, while client components leverage React (Vue.js flavors are also available). It means that you can:

• Use thousands of Symfony bundles and React components with API Platform.
• Integrate API Platform in any existing Symfony, React, or Vue application.
• Reuse all your Symfony and JavaScript skills, and benefit from the incredible amount of documentation available.
• Enjoy the popular Doctrine ORM (used by default, but fully optional: you can use the data provider you want, including but not limited to MongoDB and Elasticsearch)

Install

This repository hosts the api-platform installer used to scaffold new projects. To install it:

Static binary (recommended)

Download the latest release for your platform from the Releases page and move the binary somewhere on your $PATH:

curl -L https://github.com/api-platform/api-platform/releases/latest/download/api-platform-linux-x86_64 -o /usr/local/bin/api-platform
chmod +x /usr/local/bin/api-platform

Composer

If you already have PHP and Composer installed:

composer global require api-platform/installer

The api-platform binary will be available in ~/.composer/vendor/bin.

Usage

api-platform                # interactive wizard
api-platform my-app --framework=symfony --with-docker --with-pwa
api-platform my-app --framework=laravel

For full project documentation, read the official "Getting Started" guide.

Credits

Created by Kévin Dunglas. Commercial support is available at Les-Tilleuls.coop.