README.md

API Platform is a next-generation web framework designed to easily create API-first projects 🚀

Getting started with local development in 4 easy steps

Make sure to have Docker installed

1. In your terminal

# build containers
$ docker-compose build --pull

2. Grab a ☕️ - this may take a while

This step is optional but highly recommended

3. Back to your terminal again

# start containers
$ docker-compose up

4. Ready

Visit

• https://localhost or
• https://localhost/admin (for the admin interface) or
• https://localhost/docs (for rest-api docs) or
• https://localhost/graphql (for graphql-api docs)

Update dependencies

# Update docker images, dependencies and symfony recipes
$ sh update-deps.sh

Further Information

For detailed explanation on how things work, check out the docs.

• 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).
• Maintain data with a administration interface based on 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.