Comment passer plusieurs paramètres dans les URL d'API REST

REST API URLs sont des composants importants dans les services web. Sans eux, il serait difficile pour les sites web de localiser les ressources au sein des collections. Essentiellement, ils permettent aux sites web de modifier leur affichage en fonction des souhaits de leurs utilisateurs.

Pour bien comprendre comment passer plusieurs paramètres dans une URL REST API, comprenons d'abord la prémisse de cette question.

Qu'est-ce qu'un paramètre ?

Les paramètres sont des segments d'informations intégrés dans une URL qui fournissent des détails supplémentaires concernant une ressource ou une action demandée. Il peut également être considéré comme une couche supplémentaire de filtre pour les pages web.

Où les paramètres sont-ils utilisés ?

Il existe de nombreuses situations réelles où des paramètres sont passés dans les URL REST API. Voici quelques-uns des principaux scénarios où vous pouvez facilement repérer les paramètres en action :

• REST APIs: Les paramètres spécifient les variations de ressources, filtrent les données ou contrôlent les actions.
• Moteurs de recherche : Les paramètres sont utilisés pour affiner les requêtes de recherche ou suivre les références.
• Sites de commerce électronique : Pour filtrer les produits, gérer les paniers d'achat ou suivre les campagnes.
• Plateformes de médias sociaux : Pour personnaliser le contenu ou déclencher des actions spécifiques.

Types de paramètres courants pour passer des paramètres dans les URL REST API

Généralement, il existe deux types de paramètres que nous pouvons utiliser pour passer dans les URL REST API.

Paramètres de requête

Les paramètres de requête sont le type de paramètres qui sont ajoutés après le point d'interrogation ( ? ). Habituellement, les paramètres de requête se présentent sous la forme d'une paire clé-valeur qui est séparée par un signe égal ( = ), et chaque paire clé-valeur est jointe par une esperluette ( & ).

Une URL REST API où vous pouvez observer un paramètre de requête étant passé est :

https://api.example.com/users?id=123&name=John%20Appleseed

Les paires de paramètres clé-valeur que nous pouvons voir sont :

• id avec une valeur de 123.
• name avec une valeur de John Appleseed.

Paramètres de chemin

Les paramètres de chemin sont un autre type de paramètre d'URL qui est couramment passé dans les URL REST APU. Ceux-ci sont utilisés pour identifier et accéder à des ressources spécifiques au sein de ce système.

L'apparence et la structure des paramètres de chemin sont différentes de celles des paramètres de requête, et leurs fonctions sont également légèrement différentes. Les paramètres de chemin sont plus susceptibles d'être utilisés pour identifier de manière unique une ressource spécifique au sein d'une collection.

Un exemple de paramètre de chemin serait :

Avec un espace réservé : https://api.example.com/blog/posts/{post_id}

Sans espace réservé : https://api.example.com/blog/posts/123

Comme nous pouvons l'observer, le paramètre de chemin utilise la structure de l'espace réservé (dans cet exemple, il s'agit de {post_id}), où la valeur réelle est remplacée.

Vous pouvez même assembler plusieurs paramètres de chemin pour identifier des ressources plus spécifiques dans votre système. Un exemple plus complexe pour passer des paramètres dans une URL REST API serait :

https://api.example.com/users/{user_id}/posts/{post_id}

Tant que vous avez des valeurs existantes réelles pour remplacer les espaces réservés trouvés sur l'URL, vous pouvez modifier l'affichage de votre site web. Si vous avez remarqué, l'utilisation de paramètres de chemin produit également des URL REST API plus faciles à lire.

Étapes à suivre pour passer des paramètres dans l'URL REST API

Prenez le temps de réfléchir à l'utilisation de l'URL REST API ou à la façon dont vous souhaitez créer votre URL REST API, car différents sites web ont tendance à avoir des besoins différents, vous pouvez donc finir par préférer un type de paramètre à un autre.

Si vous prévoyez de créer un site web plus dynamique, ou que vos paramètres sont facultatifs la plupart du temps, vous pouvez envisager d'utiliser des paramètres de requête.

Cependant, vous devriez opter pour les paramètres de chemin si vous constatez que vous devez constamment adresser ces paramètres pour accéder à certaines ressources de votre système.

En plus de cela, vous devriez vous familiariser avec les meilleures pratiques pour la création d'URL REST API, car il existe quelques pointeurs que vous ne connaissez peut-être pas ou dont vous n'avez pas entendu parler auparavant.

Apidog - Plateforme de développement REST API

Apidog est une plateforme de développement d'API axée sur la conception avec une interface utilisateur élégante et épurée. Son interface simple et claire permet une navigation et une modification faciles de l'API partout où cela est nécessaire.

Apidog est également capable d'importer des API REST, de modifier les URL REST API et de tester les URL. Pour apprendre à utiliser Apidog pour modifier votre API REST, continuez à lire la section ci-dessous.

Configuration des URL, des méthodes et des points de terminaison REST API à l'aide d'Apidog

Vous pouvez créer vos propres API en utilisant Apidog, ainsi que mettre en pratique ce que vous avez appris sur le passage de plusieurs paramètres dans les URL REST API !

Flèche 1 - Vous pouvez commencer par créer une URL REST API pour votre requête. Assurez-vous qu'il n'y a pas de fautes de frappe afin de pouvoir recevoir une réponse ! Vous pouvez également déterminer le nombre de paramètres et le type de paramètres que vous souhaitez inclure.

Flèche 2 - Décidez de la méthode REST API que vous souhaitez. Les méthodes les plus courantes sont spécifiquement GET, POST, PUT et DELETE. Cependant, notez que chaque méthode peut nécessiter des paramètres et des ID dans l'URL.

Flèche 3 - Expliquez en détail les détails de l'API REST en incluant les paramètres de requête, les paramètres de réponse et des exemples de réponses ci-dessous. Il est fortement recommandé d'avoir tout rempli, car chaque variable sera incluse dans la documentation de l'API.

Test des points de terminaison d'API (ou des URL d'API) avec Apidog

Après avoir créé votre API REST, vous pouvez tester pour voir si l'URL REST API que vous créez est réussie ou non. Vous devriez pouvoir voir votre écran avec quelque chose de similaire à l'image ci-dessous :

Apidog prend en charge le test de la plupart des types de points de terminaison d'API, y compris les API SOAP et GraphQL. (Dans l'image ci-dessus, l'API affichée est une API SOAP.)

Tout d'abord, sélectionnez les requêtes de vos API REST disponibles sur le côté droit de l'écran, comme indiqué par la flèche 1.

Ensuite, vous pouvez envoyer la requête en cliquant sur le bouton pointé par la flèche 2, mais assurez-vous d'avoir sélectionné le bon environnement ou inclus l'URL de requête API correcte.

Enfin, rendez-vous dans la section de réponse pour voir la réponse reçue après l'envoi de la requête et vérifiez si elle correspond à ce qui est attendu.

Conclusion

Le passage de plusieurs paramètres dans une URL REST API deviendra une partie courante de votre processus de développement web. Au fur et à mesure que votre site web et votre base de données grandiront, la longueur et la complexité de votre URL REST API augmenteront également, il n'est donc jamais trop tôt pour commencer à vous familiariser avec un tel concept.

Si vous avez besoin d'une plateforme de développement d'API pour vous entraîner à créer des URL REST API avec plusieurs paramètres, vous pouvez toujours envisager d'utiliser Apidog. Apidog facilite également diverses modifications et spécifications pour l'ensemble du cycle de vie d'une API, alors essayez-le dès maintenant !