Downloaded 111 times
Uploaded byLes-Tilleuls.coop
API Platform and Symfony: a Framework for API-driven Projects
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.
More Related Content
Similar to API Platform and Symfony: a Framework for API-driven Projects
API Platform and Symfony: a Framework for API-driven Projects
- 1. API PLATFORM A frameworkfor API-driven Projects
- 2. Kévin Dunglas Founder ofLes-Tilleuls.coop Symfony Core Team API Platform creator @dunglas
- 3. Les-Tilleuls.coop Self-managed company since2011 100% owned by employees 25 people, 97% growth in 2016 Hiring in London, Paris and Lille: jobs@les-tilleuls.coop
- 4. The Web of2017
- 5. APIs: the Heartof the New Web
- 6. Progressive Web Apps Downloadedonly 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 Syncdata 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 Softwarebuilt, 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 theModern Web
- 10. Goals Modern API formats Arock-solid API-first project in minutes Batteries included: create, consume and deploy the API Customizable, extensible, modular: config, events, decoration…
- 11. They already UseAPI Platform
- 12.
- 13. Get Docker If youdon’t have it yet…
- 14. Install Grab a releaseon GitHub Browse https://localhost $ docker-compose up
- 16.
- 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 andHTTPS dev proxy Containers for JS dev 🤔 🤗 Symfony Standard Edition Symfony Flex Simplified directory structure MySQL PostgreSQL api-platform/api-platform@master
- 19.
- 20. Go Micro withFlex 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.
- 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 isready!
- 25. Out of theBox 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.
- 27. Symfony Validation groups Error levels SymfonyValidator integration
- 29.
- 30. Class with aRelation
- 32.
- 33.
- 34.
- 35. HTTP cache (invalidation) GETresponses 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.
- 38.
- 39.
- 40. Metadata Subsystem Properties’ typesand 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
- 41.
- 42.
- 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.
- 54.
- 55.
- 56. Install $ docker-compose execphp 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-composeexec php bin/console hautelook:fixtures:load
- 58.
- 59.
- 60. API Platform Admin SonataEasyAdmin-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:
- 63.
- 64.
- 66.
- 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.
- 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 theCloud 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.
- 78. GraphQL Support $ composerreq webonyx/graphql-php api-platform/core@master (@alanpoulain & @raoulclais)
- 80.