Créer une API en 5 mins avec API Platform

agence-anode.fr
DonovanBourlard
Donovan Bourlard
Web Developer
Awkan

Créer une API en 5min
avec API Platform

Créer une API en 5min
avec API Platform
Les outils
La théorie
En pratique
Mes conseils et astuces

Donovan Bourlard | Créer une API en 5 minutes 5
API PLATFORM
LES OUTILS
Présentation
API Platform est un framework libre (licence MIT) écrit en PHP 7
et basé sur Symfony destiné à la création d’API Web modernes,
puissantes et sécurisées. Cet outil est particulièrement adapté à
la construction de systèmes d’informations « API-centric » basés
sur l’hypermédia et le Web des données (linked data). Il permet
de réaliser facilement des applications d’une seule page
(single-page applications) ou dédiées aux mobiles en utilisant des
bibliothèques JavaScript telles que React ou AngularJS.

API PLATFORM
LES OUTILS

LES OUTILS
API PLATFORM
api-platform/core

LES OUTILS
API PLATFORM
Great !!!

18.30 AM
C ré e r u n
p roj et Sy mfony
C ré e r la
b as e d e d on n é e s
18.31 AM
VUE D’ENSEMBLE
LA THÉORIE

B ran c h e r
A PI Platfor m
C ré e r s on
s c h é ma 18.34 PM
18.35 PM
LA THÉORIE
VUE D’ENSEMBLE

EN PRATIQUE
UN PROJET

C ré e r u n
p roj et Sy mfony
EN PRATIQUE
UN PROJET

EN PRATIQUE
CRÉER UN PROJET SYMFONY
composer create-project symfony/skeleton beer-factory
beer-factory/
├─ bin/
│ └─ console
├─ config/
└─ public/
│ └─ index.php
├─ src/
│ └─ Kernel.php
├─ var/
│ ├─ cache/
│ └─ log/
└─ vendor/

EN PRATIQUE
CRÉER UN PROJET SYMFONY
beer-factory/
├─ config/
│ └─ api-platform/
│ └─ packages/
│ └─ routes/
│ └─ serialization/
│ └─ validation/
├─ src/
└─ Entity/
Nos ressources API Platform
Nos validations de données
Nos schéma de données
Nos paramètres de configurations
Nos serializations de données
Nos routes Symfony
………....
……………....
………………....
.……....
…………....
………………....

C ré e r u n
p roj et Sy mfony
EN PRATIQUE
UN PROJET
C ré e r la

EN PRATIQUE
CRÉER LA BASE DE DONNÉES
# .env
DATABASE_URL=sqlite:///%kernel.project_dir%/var/data.db
# config/packages/doctrine.yaml
doctrine:
dbal:
driver: 'pdo_sqlite'
composer require orm

C ré e r u n
p roj et Sy mfony
EN PRATIQUE
UN PROJET
C ré e r la
C ré e r s on
s c hé ma

EN PRATIQUE
CRÉER SON SCHÉMA
/**
* @ORMEntity
*/
class Beer
{
const ONLINE_STATUS = 1;
const OFFLINE_STATUS = 2;
/**
* @ORMId
* @ORMColumn(type="uuid", unique=true)
* @ORMGeneratedValue(strategy="CUSTOM")
* @ORMCustomIdGenerator(class="RamseyUuidDoctrineUuidGenerator")
*/
private $id;
/**
* @ORMColumn(type="string")
*/
private $name;
/**
* @ORMColumn(type="text", nullable=true)
*/
private $description;
/**
* @ORMColumn(type="boolean")
*/
private $organic;
/**
* @ORMManyToOne(targetEntity="Category", inversedBy="beers")
*/
private $category;
/**
* @ORMColumn(type="smallint")
*/
private $status;
// Getters + Setters
}
/**
* @ORMEntity
*/
class Category
{
/**
* @ORMId
* @ORMColumn(type="uuid", unique=true)
* @ORMGeneratedValue(strategy="CUSTOM")
* @ORMCustomIdGenerator(class="RamseyUuidDoctrineUuidGenerator")
*/
private $id;
/**
* @ORMColumn(type="string")
*/
private $name;
/**
* @ORMOneToMany(targetEntity="Beer", mappedBy="category")
*/
private $beers;
// Getters + Setters
}

EN PRATIQUE
CRÉER SON SCHÉMA
bin/console doctrine:database:create
bin/console doctrine:schema:create

C ré e r u n
p roj et Sy mfony
EN PRATIQUE
UN PROJET
C ré e r la
C ré e r s on
s c hé ma
B ran c h e r
A PI Platfor m

EN PRATIQUE
BRANCHER API PLATFORM
composer require api
/**
* @ORMEntity
* @ApiResource
*/
class Beer { /**/ }
Si l’on suit la documentation …

EN PRATIQUE
BRANCHER API PLATFORM

C ré e r u n
p roj et Sy mfony
EN PRATIQUE
UN PROJET
C ré e r la
C ré e r s on
s c hé ma
B ran c h e r
A PI Platfor m
OPÉRATIONNEL

JOUONS AVEC l’API
Créer une catégorie
EN PRATIQUE

JOUONS AVEC l’API
Créer une bière dans cette catégorie
EN PRATIQUE

JOUONS AVEC l’API
Afficher la liste des bières
EN PRATIQUE

JOUONS AVEC l’API
Modifier la bière
EN PRATIQUE

JOUONS AVEC l’API
La modification apparait dans la liste
EN PRATIQUE

JOUONS AVEC l’API
Supprimer une bière
EN PRATIQUE

JOUONS AVEC l’API
Nous n’avons plus de bière
Don't worry…
EN PRATIQUE

MES CONSEILS ET ASTUCES
ANNOTATION VS YAML
/**
* @ORMEntity
* @ApiResource({
* attributes={
* normalizationContext={"beer_read"},
* denormalizationContext={"beer_write"},
* validationGroups={"beer_write"},
* order={"createdAt": "DESC"}
* },
* collectionOperations={
* "get"={
* method="GET",
* normalizationContext={"beer_read_collection"},
* filters={
* "beer.date_filter",
* "beer.order_filter",
* "beer.search_filter"
* }
* },
* "post"={
* method="POST",
* accessControl="is_granted('ROLE_ADMIN')",
* normalizationContext={"beer_create"},
* denormalizationContext={"beer_post"},
* validationGroups="{"beer_create"}"
* },
*
* ...
* }
* })
*/
class Beer

ANNOTATION VS YAML
Utilisez YAML
# config/packages/api-platform.yaml
api_platform:
mapping:
paths: ['%kernel.project_dir%/src/Entity']
# config/packages/api-platform.yaml
api_platform:
mapping:
paths: ['%kernel.project_dir%/config/api-platform']
Annotation
YAML

ANNOTATION VS YAML
Configuration des ressources YAML
beer-factory/
├─ bin/
├─ config/
│ └─ api-platform/
│ └─ beer.yaml
│ └─ category.yaml
└─ public/
├─ src/
├─ var/
└─ vendor/
# config/api-platform/beer.yaml
AppEntityBeer: ~
# config/api-platform/category.yaml
AppEntityCategory: ~

ANNOTATION VS YAML
Configuration des ressources YAML

VALIDER LES DONNÉES
Que se passe-t-il si j’envoie des données erronées ?
Le champ description est nullable, OK

Le champ name est obligatoire, ERREUR 500

# config/packages/validator.yaml
framework:
validation:
mapping:
paths: ['%kernel.project_dir%/config/validation']
# config/validation/beer.yaml
AppEntityBeer:
properties:
name:
- NotBlank: ~

Le champ name est obligatoire, ERREUR 400

SÉLECTION DES DONNÉES
Je ne souhaite pas exposer tous les champs
Serialization
« Composant permettant de transformer des objets en différents
formats (JSON, XML, …) »
à On veut « cacher » des champs dans certaines routes de Beer
beer-factory/
├─ bin/
├─ config/
│ └─ packages/
│ └─ serializer.yaml
│ └─ serialization/
│ └─ beer.yaml
└─ public/
├─ src/
├─ var/
└─ vendor/

Paramétrage de la serialization
# config/api-platform/beer.yaml
AppEntityBeer:
attributes:
denormalization_context: { groups: ['beer_write'] }
normalization_context: { groups: ['beer_read'] }
collectionOperations:
get:
method: 'GET'
normalization_context: { groups: ['beer_read_collection'] }
post:
method: 'POST'
# Optionnal since it's default config
denormalization_context: { groups: ['beer_write'] }
normalization_context: { groups: ['beer_read'] }
itemOperations:
get:
method: 'GET’
# Optionnal since it's default config
# denormalization_context: { groups: ['beer_write'] }
# normalization_context: { groups: ['beer_read'] }
put:
method: 'PUT'
delete:
method: 'DELETE'
# config/packages/serializer.yaml
framework:
serializer:
mapping:
paths: ['%kernel.project_dir%/config/serialization']
On déclare où vont se trouver les fichiers de
serialization

Les données en lecture
AppEntityBeer:
attributes:
name:
groups: ['beer_read_collection']
AppEntityBeer:
attributes:
name:
groups: ['beer_read']
description:
# config/serialization/beer.yaml
AppEntityBeer:
attributes:
name:
groups: ['beer_read’, 'beer_read_collection']
description:
N’afficher que le nom dans la liste Ajouter la description dans le détail

On ne voit que le champ name dans la liste des bières

On voit que les champs name et description dans le détail d’une bière

Les données en écriture
AppEntityBeer:
attributes:
name:
groups: ['beer_read', 'beer_read_collection', 'beer_write']
description:
groups: ['beer_read', 'beer_write']
organic:
groups: ['beer_write']
status:
groups: ['beer_write']
Même chose pour les champs où l’on peut écrire …

Les données en écriture
- On peut soumettre tous les champs avec le groupe beer_write
- On voit les champs avec le groupe beer_read

Ascend | Presentation 56
Quelques ressources
SLACK
https://symfony-devs.slack.com
Channel #api-platform
GITHUB
https://github.com/Awkan/
meetup-api-platform
API PLATFORM
https://api-platform.com/

Merci de votre attention
Avez-vous des questions ?

Créer une API en 5 mins avec API Platform

Recommandé

Recommandé

Contenu connexe

Similaire à Créer une API en 5 mins avec API Platform

Similaire à Créer une API en 5 mins avec API Platform (20)

Dernier

Dernier (20)

Créer une API en 5 mins avec API Platform