API Platform and Symfony: a Framework for API-driven Projects
7 likes20,714 views
API Platform is a framework for building API-driven projects that provides out-of-the-box features like JSON-LD and Hydra formats, OpenAPI documentation, data validation, HTTP caching, and more. It uses Symfony components and Doctrine ORM and allows creating an API from existing entity classes with annotations. The framework includes tools for building admin interfaces, generating React clients, and deploying APIs to Kubernetes.
API Platform and Symfony: a Framework for API-driven Projects
- 1. API PLATFORM A framework for API-driven Projects
- 2. Kévin Dunglas Founder of Les-Tilleuls.coop Symfony Core Team API Platform creator @dunglas
- 3. Les-Tilleuls.coop Self-managed company since 2011 100% owned by employees 25 people, 97% growth in 2016 Hiring in London, Paris and Lille: [email protected]
- 4. The Web of 2017
- 5. APIs: the Heart of the New Web
- 6. Progressive Web Apps Downloaded only 1 time, works offline! Sends async HTTP requests to the API Huge ecosystem: React, Angular, Vue… Holds the presentation logic Static « website »: JS, HTML and CSS Modernized stack: ES2015, Babel, Webpack, Yarn, Flow, TypeScript, ReasonML…
- 7. Native Mobile Apps Sync data by sending HTTP requests to the API JS stack: React Native, NativeScript Downloaded from stores (App Store, Google Play) Look’n’Feel consistent with the platform (iOS or Android)
- 8. Cloud Native Projects Software built, tested and deployed continuously Rich and open ecosystem: Docker, Kubernetes, Mesos, Terraform… Projects are hosted on public and private clouds Containers and orchestration from dev stations to prod
- 9. A Framework for the Modern Web
- 10. Goals Modern API formats A rock-solid API-first project in minutes Batteries included: create, consume and deploy the API Customizable, extensible, modular: config, events, decoration…
- 11. They already Use API Platform
- 12. Getting Started
- 13. Get Docker If you don’t have it yet…
- 14. Install Grab a release on GitHub Browse https://localhost $ docker-compose up
- 16. Just 1 class
- 17. Included (v2.1 - stable) PHP FPM and Nginx containers, sensitive defaults for Symfony Varnish container (more about this later) Cross-platform Docker setup MySQL container Symfony Edition fine tuned for APIs
- 18. Upcoming Changes HTTP/2 and HTTPS dev proxy Containers for JS dev 🤔 🤗 Symfony Standard Edition Symfony Flex Simplified directory structure MySQL PostgreSQL api-platform/api-platform@master
- 19. Too Much?
- 20. Go Micro with Flex Browse http://localhost:8000 $ composer create-p symfony/skeleton api $ cd api $ composer req api $ php -S 127.0.0.1:8000 -t public
- 21. Your Turn!
- 22. Create your Class PHPDoc extraction (optional) The hook:@ApiResource XML and YAML also supported Doctrine integration (optional) $ docker-compose exec php bin/console doctrine:schema:update --force Plain Old PHP Object
- 23. Your 1st API is ready!
- 25. Out of the Box Features JSON-LD + Hydra formats But also… JSONAPI, HAL, XML, YAML, CSV and raw JSON… OpenAPI (aka Swagger) doc Nice UI (Swagger UI) POST, GET (item and lists), PUT, DELETE Pagination for lists (30 items per page), fully configurable
- 26. Data Validation
- 27. Symfony Validation groups Error levels Symfony Validator integration
- 29. Relations
- 30. Class with a Relation
- 35. HTTP cache (invalidation) GET responses generated only 1 time, then served by Varnish (also work with CloudFlare and any cache proxy supporting tags) Responses tagged with IRIs (URLs) of resources they contain (including relations, embedded resources…) When a write operation occurs cached responses containing outdated data are purged Builtin, single config flag, trusted proxies config provided Browse https://localhost:444
- 36. Other Features
- 39. Core Library
- 40. Metadata Subsystem Properties’ types and relations extracted with Symfony PropertyInfo Guesses API’s structure (resources and properties) from classes marked@ApiResource Intermediate representation of the API structure Used by Hypermedia normalizers (JSON-LD, Hydra, HAL…) registered in the Symfony Serializer
- 43. JSON-LD Standardized hypermedia format: W3C recommandation (2014) Easy to use: a standard JSON document with some specials keys (starting with @) and mapped with a context Backed by Google, BBC, Microsoft, US & UK govs... Compliant with technologies of the semantic web: RDF, SPARQL, triple store... JSON for Linked Data
- 50. Hydra auto-discoverable API: resources, properties, types, operations Standardize common API structures: collections, paginations, filters, errors… In-band API doc Draft W3C
- 53. Data Fixtures
- 54. More Properties
- 55. More Properties
- 56. Install $ docker-compose exec php composer req doctrine/data-fixtures:^1.2 nelmio/alice:^3.0 theofidry/alice-data-fixtures:^1.0@beta hautelook/alice-bundle:^2.0@beta
- 57. Loading Fixtures $ docker-compose exec php bin/console hautelook:fixtures:load
- 59. Admin
- 60. API Platform Admin Sonata EasyAdmin-like but as a React PWA Built on top of Admin On Rest (by Marmelab) Material Design Automatically generates the admin by parsing the Hydra API doc Browse https://localhost:8001
- 62. Alternatively… $ yarn add @api-platform/admin From any React installation:
- 67. React PWA Generator (default) SensioGeneratorBundle-like, 100% client-side Rock solid stack $ yarn global add @api-platform/client-generator Twitter Bootstrap support + accessibility (ARIA roles) Use ES2015’s fetch() Parse Hydra API doc to generate files
- 71. The Stack React, ES2015+, JSX React Router: client-side routing library Redux: extensible container to manage the states of the app Redux Form: forms Redux Thunk: async actions (AJAX requests) Optional: Twitter Bootstrap
- 72. Other Skeletons React Native: master branch (@mysiar) TypeScript definitions: master branch (@soyuka) Your preferred technology: Pull Requests very appreciated! Angular: community (momenttech/lysis) Vue.js: api-platform/client-generator#35 (@alOneh)
- 73. React Native $ generate-api-platform-client http://localhost src/ —g react-native
- 74. Deploy in Clouds
- 75. Kubernetes & Helm K8S: « Production-Grade Container Orchestration », by Google Powers Google Kubernetes Engine and Azure Container Service Helm: official K8S package manager (like APT or Homebrew), by Microsoft Free software
- 76. Deploy in the Cloud A Helm chart is provided with API Platform # …Build and push the Docker images… # …Connect to your Kubernetes cluster… $ helm install ./api/helm/api --name api The project is deployed, managed, and scale!
- 77. One More Thing…
- 78. GraphQL Support $ composer req webonyx/graphql-php api-platform/core@master (@alanpoulain & @raoulclais)