Interface de programmation (API)

1. Introduction

Une interface de programmation, également nommée API (Application Programming Interface), permet d’ouvrir les fonctionnalités du cœur de son application à d’autres applications et d’autres utilisateurs. En rendant possible l’utilisation de vos fonctionnalités dans d’autres applications, vous améliorez l’interopérabilité du code.

CakePHP facilite la création de ces interfaces de programmation en s’appuyant sur l’architecture REST (Representational State Transfer). Le plus souvent, REST utilise les formats de fichier XML et JSON et s’appuie sur les en-têtes HTTP pour déterminer les actions à affecter.

2. Créer des routes RESTful

La première étape de la construction de l’interface de programmation est d’indiquer à CakePHP de créer des routes RESTful, c’est-à-dire qui utilisent les en-têtes HTTP pour déterminer l’action à exécuter.

Pour ce faire, il suffit d’indiquer dans le fichier config/routes.php les nouvelles extensions de fichier à utiliser ainsi que les ressources, c’est-à-dire les modèles de l’application qui doivent être exposés dans l’interface de programmation.

Exemple :


Router::scope('/', function ($routes) {  
    $routes->extensions(['json']);  
    ...
Pour consulter la suite, découvrez le livre suivant :
couv_EP3CAK.png
60-signet.svg
En version papier
20-ecran_lettre.svg
En version numérique
41-logo_abonnement.svg
En illimité avec l'abonnement ENI
130-boutique.svg
Sur la boutique officielle ENI
Précédent
Internationalisation
Suivant
Introduction