API Platform Framework
The easiest way to create your web API
Install the framework
Install
gh repo create --clone --template api-platform/api-platform my-api --public # or --private
cd my-api
docker compose up
open https://localhostgh repo create --clone --template api-platform/api-platform my-api --public # or --private
cd my-api
docker compose up
open https://localhostYour development environment is ready!
Continuous integration (GitHub Action) as well as recipes to deploy in production with Docker Compose or Kubernetes are also pre-installed.Define the resourcesas PHP classes, or using OpenAPI
Define the resources to expose
<?php
namespace App\ApiResource;
#[ApiResource]
class Beer
{
public int $id;
public string $name;
}<?php
namespace App\ApiResource;
#[ApiResource]
class Beer
{
public int $id;
public string $name;
}Automatic documentation OpenAPI, SwaggerUI, GraphiQL...
Alternatively, generate the classes from an existing RDF vocabulary.
API Platform automatically exposes production-grade HATEOAS API for you!
Plug your business & persistence logic
Plug your logic
class MyProcessor implements ProcessorInterface
{
// …
}
class MyProvider implements ProviderInterface
{
// …
}class MyProcessor implements ProcessorInterface
{
// …
}
class MyProvider implements ProviderInterface
{
// …
}The framework has been designed from the ground up to be usable from Rapid Application Development contexts to Domain-Driven Design or Clean Architecture-like approaches.
You can even mix both approaches!
...or use the native integration with popular persistence libraries!
Native integration
use ApiPlatform\Metadata\ApiResource;
use Doctrine\ORM\Mapping as ORM;
#[ORM\Entity]
#[ApiResource]
// …use ApiPlatform\Metadata\ApiResource;
use Doctrine\ORM\Mapping as ORM;
#[ORM\Entity]
#[ApiResource]
// …API Platform can automatically retrieve, persist, paginate and validate data using the most popular database systems.
PostgreSQL, MongoDB, ElasticSearch, SQLite, MySQL, MariaDB, SQL Server and Oracle are supported out of the box.
You can also make your own persistence system!
Customize!
Customize every single behavior thanks to our carefully designed extension points.
Client generator
Scaffold client apps
We provide a scaffolding with first-class support for Next.js, but don't want to decide for you which front-end framework you want to work with so skeletons for many other frontend frameworks are supported such as: Nuxt (Vue), Expo (React Native), Quasar, and many more...
Learn more
API Platform admin
Enjoy a beautiful B2B interface
API Platform Admin exposes your data trough a beautiful UI.
100% no code
Automatic API discovery
Mercure.rocks
Go real time
API Platform automatically leverages the Mercure protocol to send updates made to your resources to all the connected clients. Updates are automatically broadcasted by the API component. The admin and all the generated client skeletons are also natively able to receive the event and update the UI automatically.
Learn more
More features
Going further
