This repository is now archived (since 2025-12-24).
This is a fork of the original project, this fork is compatible with Scalingo for one click deployment.
This one-click deployment, only deploy the API service of API-Platform, it doesn't deploy the Admin interface and the Client interface build with generator.
- Compatible with Scalingo PHP Buildpack
- Logs output from Symfony is available with the addition of monolog bundle package and use of
php://stderr - Mercure and Varnish integrations disabled by default
Actual API-Platform version: 2.5.3
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 one from the Schema.org vocabulary.
- 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, JSONAPI, YAML, JSON, XML and CSV are supported out of the box.
- Enjoy the beautiful automatically generated API documentation (Swagger/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 React, 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 JSON Web Token or OAuth authentication.
- Create specs and tests with a developer friendly API testing tool on top of Behat.
The official project documentation is available on the API Platform website.
API Platform embraces open web standards (OpenAPI, JSON-LD, GraphQL, Hydra, HAL, JSONAPI, JWT, OAuth, HTTP...) and the Linked Data movement. Your API will automatically expose structured data in Schema.org / JSON-LD. 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 (a Vue.js flavor is 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 or React application.
- Reuse all your Symfony and React skills, benefit of 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)
Read the official "Getting Started" guide.
Created by Kévin Dunglas. Commercial support available at Les-Tilleuls.coop.