README

The new breed of web frameworks

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

API Platform is a next-generation PHP web framework designed to create API-first projects easily but without compromise in the field of extensibility and flexibility:

Use our awesome code generator to bootstrap a fully-functional data model from Schema.org vocabularies with ORM mapping and validation (you can also do it manually)
Expose in minutes an hypermedia REST API that works out of the box by reusing entity metadata (ORM mapping, validation and serialization) ; that embraces JSON-LD, Hydra and provides a ton of features (CRUD, validation and error handling, relation embedding, filters, ordering...)
Enjoy the beautiful automatically generated API documentation (Swagger-like)
Add easily JSON Web Token or OAuth authentication
Create specs and tests with a developer friendly API context system on top of Behat
Develop your website UI, webapp, mobile app or anything else you want using your preferred client-side technologies! Tested and approved with AngularJS (integration included), Ionic, React and native mobile apps

API Platform embraces open web standards (JSON-LD, Hydra, JWT, OAuth, HTTP, HTML5...) 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 recommends these formats. And yes, Google crawls full-Javascript applications as well as old-fashioned ones.

Last but not least, API Platform is built on top of the Symfony full-stack framework and follows its best practices. It means than you can:

use thousands of Symfony bundles with API Platform
integrate API Platform in any existing Symfony application
reuse all your Symfony skills and benefit of the incredible amount of Symfony 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 ODM and ElasticSearch)

Install

Use Composer to create your new project:

composer create-project api-platform/api-platform my-api

Start to hack

A demo application (a bookstore) is pre-installed.

Run app/console server:start and open http://localhost:8000 in any HTTP client to access the API
Open http://localhost:8000/doc to read the HTML documentation an play with the sandbox
Give a try to the HydraConsole client to leverage JSON-LD and Hydra features
Build your first custom client using Javascript, CORS headers are already configured

What's inside?

API Platform provides rock solid foundations to build your project:

The Schema Generator to generate PHP entities from Schema.org types with Doctrine ORM mappings, Symfony validation and extended PHPDoc
The API bundle to expose in minutes your entities as a JSON-LD and Hydra enabled hypermedia REST API
NelmioApiDocBundle integrated with the API bundle to automatically generate a beautiful human-readable documentation and a sandbox to test the API
Behat and Behatch configured to easily test the API
The full power of the Symfony framework and its ecosystem
Doctrine ORM/DBAL
An AppBundle you can use to start coding
Annotations enabled for everything
Swiftmailer and Twig to create beautiful emails

It comes pre-configured with the following bundles:

Symfony - API Platform is built on top of the full-stack Symfony framework
API Platform's API bundle - Creates powerful Hypermedia APIs supporting JSON-LD and Hydra
NelmioCorsBundle - Support for CORS headers
NelmioApiDocBundle - Generates a human-readable documentation
FosHttpCacheBundle - Add powerful caching capacities, supports Varnish, Nginx a built-in PHP reverse proxy
SensioFrameworkExtraBundle - Adds several enhancements, including template and routing annotation capability
DoctrineBundle - Adds support for the Doctrine ORM
TwigBundle - Adds support for the Twig templating engine (useful in emails)
SecurityBundle - Authentication and roles by integrating Symfony's security component
SwiftmailerBundle - Adds support for Swiftmailer, a library for sending emails
MonologBundle - Adds support for Monolog, a logging library
WebProfilerBundle (in dev/test env) - Adds profiling functionality and the web debug toolbar
SensioDistributionBundle (in dev/test env) - Adds functionality for configuring and working with Symfony distributions
SensioGeneratorBundle (in dev/test env) - Adds code generation capabilities

All libraries and bundles included in API Platform are released under the MIT or BSD license.

Authentication support

Json Web Token is a lightweight and popular way to handle authentication in a stateless way. Install LexikJWTAuthenticationBundle to adds JWT support to API Platform.

Oauth support can also be easily added using FOSOAuthServerBundle.

Verifying release signature

Software released by the API Platform project can be verified with git using the following GPG public signature:

Enjoy!

Credits

Created by Kévin Dunglas. Sponsored by Les-Tilleuls.coop Commercial support available upon request.

dunglas / api-platform

Maintainers

Details