PHPackages dunglas/api-platform - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [Framework](/categories/framework) 4. / 5. dunglas/api-platform Abandoned → [api-platform/api-platform](/?search=api-platform%2Fapi-platform)Project[Framework](/categories/framework) dunglas/api-platform ==================== The API Platform framework v2.1.6(8y ago)358106MITPHPPHP >=7.0 Since Jun 12Pushed 6mo ago6 watchersCompare [ Source](https://github.com/dunglas/api-platform)[ Packagist](https://packagist.org/packages/dunglas/api-platform)[ Docs](https://api-platform.com)[ RSS](/packages/dunglas-api-platform/feed)WikiDiscussions master Synced 1mo ago READMEChangelogDependencies (22)Versions (43)Used By (0) The API Platform framework ========================== [](#the-api-platform-framework) [![Join the chat at https://gitter.im/api-platform/api-platform](https://camo.githubusercontent.com/abe08b740a4156153736f791393ec4da6619c4be73212e75769f52edacc0e2b5/68747470733a2f2f6261646765732e6769747465722e696d2f4a6f696e253230436861742e737667)](https://gitter.im/api-platform/api-platform?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) *The new breed of web frameworks* [![API Platform](https://camo.githubusercontent.com/697a6914ca8105ae50766599e635c95b0626222a52bf8ea1535d9bbd1e902e4e/68747470733a2f2f6170692d706c6174666f726d2e636f6d2f696d616765732f6170692d706c6174666f726d2d6c6f676f2e32376130383533372e706e67)](https://api-platform.com) The official project documentation is available **[on the API Platform website](https://api-platform.com)**. 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](http://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](http://json-ld.org), [Hydra](http://hydra-cg.com) 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](http://jwt.io/) or [OAuth](http://oauth.net/) authentication** - Create specs and tests with a **developer friendly API context system** on top of [Behat](https://behat.readthedocs.org) - 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](https://en.wikipedia.org/wiki/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](https://developers.google.com/structured-data/)**. And yes, Google crawls full-Javascript applications [as well as old-fashioned ones](http://searchengineland.com/tested-googlebot-crawls-javascript-heres-learned-220157). Last but not least, API Platform is built on top of the [Symfony](https://symfony.com)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](http://www.doctrine-project.org) (used by default, but fully optional: you can use the data provider you want, including but not limited to MongoDB ODM and ElasticSearch) Install ------- [](#install) Use [Composer](https://getcomposer.org) to create your new project: ``` composer create-project api-platform/api-platform my-api ``` Start to hack ------------- [](#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](http://www.hydra-cg.com/) client to leverage JSON-LD and Hydra features - Build your first custom client using Javascript, CORS headers are already configured What's inside? -------------- [](#whats-inside) API Platform provides rock solid foundations to build your project: - [**The Schema Generator**](https://api-platform.com/doc/1.0/schema-generator/) to generate PHP entities from [Schema.org](http://schema.org) types with Doctrine ORM mappings, Symfony validation and extended PHPDoc - [**The API bundle**](https://api-platform.com/doc/1.0/api-bundle/) to expose in minutes your entities as a JSON-LD and Hydra enabled hypermedia REST API - [**NelmioApiDocBundle**](https://github.com/nelmio/NelmioApiDocBundle) integrated with the API bundle to automatically generate a beautiful human-readable documentation and a sandbox to test the API - [Behat](https://behat.readthedocs.org) and [Behatch](https://github.com/Behatch/contexts) configured to easily test the API - The full power of the [**Symfony**](https://symfony.com) framework and its ecosystem - **[Doctrine](http://www.doctrine-project.org) 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**](https://symfony.com) - API Platform is built on top of the full-stack Symfony framework - [**API Platform's API bundle**](https://api-platform.com/doc/1.0/api-bundle/) - Creates powerful Hypermedia APIs supporting JSON-LD and Hydra - [**NelmioCorsBundle**](https://github.com/nelmio/NelmioCorsBundle) - Support for CORS headers - [**NelmioApiDocBundle**](https://github.com/nelmio/NelmioApiDocBundle) - Generates a human-readable documentation - [**FosHttpCacheBundle**](https://foshttpcachebundle.readthedocs.org) - Add powerful caching capacities, supports Varnish, Nginx a built-in PHP reverse proxy - [**SensioFrameworkExtraBundle**](https://symfony.com/doc/current/bundles/SensioFrameworkExtraBundle/index.html) - Adds several enhancements, including template and routing annotation capability - [**DoctrineBundle**](https://symfony.com/doc/current/book/doctrine.html) - Adds support for the Doctrine ORM - [**TwigBundle**](https://symfony.com/doc/current/book/templating.html) - Adds support for the Twig templating engine (useful in emails) - [**SecurityBundle**](https://symfony.com/doc/current/book/security.html) - Authentication and roles by integrating Symfony's security component - [**SwiftmailerBundle**](https://symfony.com/doc/current/cookbook/email.html) - Adds support for Swiftmailer, a library for sending emails - [**MonologBundle**](https://symfony.com/doc/current/cookbook/logging/monolog.html) - 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**](https://symfony.com/doc/current/bundles/SensioGeneratorBundle/index.html) (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 ---------------------- [](#authentication-support) Json Web Token is a lightweight and popular way to handle authentication in a stateless way. Install [**LexikJWTAuthenticationBundle**](https://github.com/lexik/LexikJWTAuthenticationBundle) to adds JWT support to API Platform. Oauth support can also be easily added using [**FOSOAuthServerBundle**](https://github.com/FriendsOfSymfony/FOSOAuthServerBundle). Verifying release signature --------------------------- [](#verifying-release-signature) Software released by the API Platform project [can be verified with `git`](https://git-scm.com/book/tr/v2/Git-Tools-Signing-Your-Work#Verifying-Tags)using the following GPG public signature: ``` -----BEGIN PGP PUBLIC KEY BLOCK----- Version: GnuPG v1 mQINBFV3AEgBEACjS6QwFIOEOuYAqUVBbUeuSAOdE6RmdV4OVnN62fkW2Sp8IPud s8oOmiyFlj1e3BoPDjvsnRj6qplHQ9stCXyfWgaoVRLhTcu3Wm+2ZzcyZgywva6Z npmEf9DA0MOH9dOE2sAAUktqU1n+PBsm6zIVhv5hu9j781h56/ep+IIJPJErPNDa Y1Q5b4OkFfHBqiMDa9m1BNtK7anjwFSGpAPSdusQh5mCuEEpCs/JqQ9aOVDJdEBP j1nccGN7kzPHdvIMxCHlotrOu2gBRXqmRLzUocu5XsG4nUOVLeilVS/pUI0uWMDC fje/b5JaaCMK8MxgNFVf9XaiGH2QVecAbabDrxPrCAuyaHrlMyUcEnDz0aDJeKb/ fT1pvCcHVGgocg+lA8VjPCQTsmaTz29qKq1djl4OoGa0Vmu+hEpWFVkBk3C3AVjo 9zCb4W5+080YQ6+fnlz5zY4u6twKucs9iLvRMHUjhppLmxlBqWpj/UDdVkXh6Lak ZwpdDJTIojAPi5C4z9EsOYl9PhqxqNOUPcEDJGSZKf7WERqvGvy9VVHww/O8jjw/ D2qaK5EDlrxCTazmfCtCY9Vx7dKt3kGp7vi9FHof9nQbfyqyZ1xMEli/ZjCsk5qj gejRj0S+lCTXPOvrluoFwAWJs4SapFe6p6gfBWWA84bL4hgk80dHoAo8wwARAQAB tCJLw6l2aW4gRHVuZ2xhcyA8ZHVuZ2xhc0BnbWFpbC5jb20+iQI4BBMBAgAiBQJV dwBIAhsDBgsJCAcDAgYVCAIJCgsEFgIDAQIeAQIXgAAKCRBNBOvvBqrzpj1DD/9k efO91zOnzQVOxCoAex4puMyp9N0GnIqNHLExAl13epvzmzn2kMMliDWFSMnHd35s NFAmXaKZCNYkSeje05wdTiKEkwZRF7vKIAjPc9e9agHit6tsEyfbBeCq8SYlut2c YRWRNrvOz7hmpwcHwlpGj24tu33abondvtmFjByhsLWNY8PY7QRPDUOMbbfgloC2 JO+H8mIZzDTsSGRogwP2aiAKS4ai2Xm/PMrD0BLi08d2F+29rESPG69fLzxEnarE DokpsHmYztdOSxLyw6SMU8Z7DB7cVwstuyy+riiwpMz/oxxkmYWCwBPnn6Bst7h9 haQkclGZZvXWyhFfKwX+XDz/a9JvTcbMwP+d7rRx9eMxTSZ+2uoVtBMxAqdlpFbk 4RWCnDs8LorYH3DSN9IR4cUOSI8yDbCJsSe3ic5C7gtT9DDYcuxii44UtgLrXcXn ZJOpaf9yhiZurd7+kA3J3bhNwk5G8Wa5UUiD4s6gHHD5FioUFX2aitlONNHmVjJX ma4fuhYQtb/rVzP242GxjxPCy+lW33NNk7T2NfKw5tGbbafmEUWd0eU+bmEF0vgJ gni2s4FG2lXrHTpdkOFkfnhJQCkD1dMhD2D5NZgpLbjO5lQEZdzQ2n0VG9pwcQSw /rwqlg6L+J3swvd8SA/oyxbuOLKOxoYUa8qaP7ZrJrkCDQRVdwBIARAAzwQrKBT5 8TkskjYPNnKnn6GFtiVe5bp32ZxuPDUHgV9rzGbWEVzCNzfHtxhMf78HjUIboQsb wga+m7cdvd0z7vxCf8AoQeu1oPXco/lOnJLGpHkDXEsnxoRY6iJJn3aNkvjKgBT+ FsddepeehdAvLkGgJOTM04zoNFebbNi9oQji99udVQTADbra9QK7AxFTUOHv9DL1 ap8/BIpfd0yWUHnQF2VFnYSXHr0oZTxDHLK+LdY2fmMnHfI1EK1CcKVtZdzByuEu WA4DsOmpZIfq974VFTxoh170jZuHCxOiZY1ZXdAWtLD4rLNX/mnb2PTRu02avFva UD9rwEtUpk32lqh7NOxvlG7pd7pUMZ+oMCHkJFi+QHVw0ogx5h1tSDd5qf12Ck6E 2g4CrEpTTs3nDYtwozgSlYPPY6nj4TGSOGShj2EjGWw5C2pDne3nnR896y3C2EOi ALqrufieNCxYkcen3XPG3qBQqU/yg3HpTUTvNloYV26CuGkvxAzryGQW7B7Lw459 84FHAaWIl5CjM6yZl2NAROdzjZkf2a0dSY9JGyLz9dChnxuUM/EJqyWw8q4IO7Xe rVbZsFipjWvzs9Z0JqKYe803misN7POugcAsbz0tGUUrb3DM0qKeHHoqSz5nxNlo Ze25ZHMsw8JnJjGWngeKUA/NlnPh9peKvR8AEQEAAYkCHwQYAQIACQUCVXcASAIb DAAKCRBNBOvvBqrzpn7REACaa4Y/FtcSJIbQxa4LE5MjKU53Kp0ooQHmsd0ObsAS uHLoGEuVw6wah20wk6NrnZSdgl3UdUw1/jbQAuKqeQYBPvHfoN7xEUk4CsdfTyDL lGhUoLAoYcIazdVgm5+/Ud5eQAcItAEXxekZ32/Ln6fvqLzogJESM4mMvgxtVomt dwsE9y4V30+U2Mguq6FTF65DH5c8toBHaD5L5CT8B0QNMCPX5l2zvmB91ZCH4Cvj s+FDO4KXpUkD04bqlgyf0s/toUO5n0i9o9mIy701BUe/Me0L23s8jOITxi9jDCZ0 ZU2gLxly2rnl9+n6pWknl8sAHDtJ/KQNqi7hxikqKbJg+F6XNWG1TiFV6WfexzNA I48HrKMjoAVMS/7pQIOJBnDfmCgMTifYVFpMh3Coy4tyiAPt8yZXjEMnvu4gdr0v WsUHMZkQP2Llx4vb3GAQ2g63QQKF4EWzRHscYmWoOX6DR24VBlAqPTFJCNb7UYXQ nc56HwlOb4lLTpGpbT62TobWfXOldx87xCIwEfgGSRO/5X9sDbKimrLDEMUeyBvH u5B+QDNmyyu8LmNj6xqGaJS8JNKVmaFpBCw6w6bPTCahF+dJ977nLXQUfz9Spitn ihCxYX4tb4whrhNkPLmwCRz4EfzWJFgdtpcVaEk9oWHe02lSp+XO8bOAs9QJuGx1 xA== =RO9E -----END PGP PUBLIC KEY BLOCK----- ``` Enjoy! Credits ------- [](#credits) Created by [Kévin Dunglas](https://dunglas.fr). Sponsored by [Les-Tilleuls.coop](https://les-tilleuls.coop)Commercial support available upon request. ### Health Score 43 — FairBetter than 91% of packages Maintenance46 Moderate activity, may be stable Popularity26 Limited adoption so far Community19 Small or concentrated contributor base Maturity70 Established project with proven stability Bus Factor1 Top contributor holds 66.7% of commits — single point of failure How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Every ~27 days Total 37 Last Release 3017d ago Major Versions v1.1.0-beta.1 → v2.0.0-alpha.12016-05-16 PHP version history (2 changes)v1.0.0-betaPHP >=5.5.0 v2.0.0-alpha.1PHP >=7.0 ### Community Maintainers ![](https://avatars.githubusercontent.com/u/57224?v=4)[Kévin Dunglas](/maintainers/dunglas)[@dunglas](https://github.com/dunglas) --- Top Contributors [![dunglas](https://avatars.githubusercontent.com/u/57224?v=4)](https://github.com/dunglas "dunglas (18 commits)")[![sroze](https://avatars.githubusercontent.com/u/804625?v=4)](https://github.com/sroze "sroze (3 commits)")[![theofidry](https://avatars.githubusercontent.com/u/5175937?v=4)](https://github.com/theofidry "theofidry (1 commits)")[![toofff](https://avatars.githubusercontent.com/u/966550?v=4)](https://github.com/toofff "toofff (1 commits)")[![tpluscode](https://avatars.githubusercontent.com/u/588128?v=4)](https://github.com/tpluscode "tpluscode (1 commits)")[![aitboudad](https://avatars.githubusercontent.com/u/1753742?v=4)](https://github.com/aitboudad "aitboudad (1 commits)")[![vincentchalamon](https://avatars.githubusercontent.com/u/407859?v=4)](https://github.com/vincentchalamon "vincentchalamon (1 commits)")[![gitter-badger](https://avatars.githubusercontent.com/u/8518239?v=4)](https://github.com/gitter-badger "gitter-badger (1 commits)") ### Code Quality TestsBehat ### Embed Badge ![Health badge](/badges/dunglas-api-platform/health.svg) ``` [![Health](https://phpackages.com/badges/dunglas-api-platform/health.svg)](https://phpackages.com/packages/dunglas-api-platform) ``` ### Alternatives [prestashop/prestashop PrestaShop is an Open Source e-commerce platform, committed to providing the best shopping cart experience for both merchants and customers. 9.0k15.4k](/packages/prestashop-prestashop)[ec-cube/ec-cube EC-CUBE EC open platform. 78527.0k1](/packages/ec-cube-ec-cube)[open-dxp/opendxp Content & Product Management Framework (CMS/PIM) 7310.3k29](/packages/open-dxp-opendxp)[forumify/forumify-platform 121.8k11](/packages/forumify-forumify-platform) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)