octobre 20, 2022

Comment créer une API Rest personnalisée

Dans ce tutoriel, nous allons apprendre à créer un service Web RESTful personnalisé dans Drupal 9.

Avant de créer Rest Api, nous devons savoir ce qu’est l’API REST. Une interface de programmation d’application (API ou API Web) permet l’interaction avec les services Web RESTful. Où REST est connu sous le nom de transfert d’état représentatif.

Première, Nous devrons installer ces modules de base HTTP Basic Authentication, REST Web Services et le module de sérialisation.

Ensuite, installez le module Contributed appelé REST UI, sur lequel vous pouvez télécharger
le compositeur nécessitant ‘drupal/restui:^1.21’

Créons un module personnalisé nommé « Exemple de repos” dans /modules/personnalisé

Après cela créer ExempleRest.php

dans le répertoire /modules/custom/rest_example/src/Plugin/rest/resource/ExempleRepos.php.

Il s’agit de notre fichier de ressources personnalisé qui aura une méthode get qui obtiendra tous les nœuds de type de contenu Équipes de football.

/**
* Provides a Rest Resource Example
*
* @RestResource(
* id = "rest_example",
* label = @Translation("Rest Example Resource"),
* uri_paths = {
* "canonical" = "/rest_example"
* }
* )
*/

Comprenons l’annotation.

@RestResource est une fonction, à travers laquelle savoir, c’est une sorte de ressource de repos
identifiant définir l’identifiant de l’API Rest Resource
étiquette afficher à l’utilisateur par lequel l’auteur peut connaître cette API
uri_paths : canonique les attributs définissent le chemin de l’API.

Dans notre cas, nous utiliserons « sitename/rest_example » pour accéder à notre API. Après cela, nous devons installer notre module.

Ensuite aller à /admin/config/services/rest et activez notre ressource personnalisée Ressource d’exemple de repos

Après cela, sélectionnez les options suivantes

De plus, autorisez l’autorisation anonyme à notre ressource de repos.

Maintenant, nous allons frapper notre ressource get.