Différences

Ci-dessous, les différences entre deux révisions de la page.

--- adel:utilisateurs:api-rest:generalites [2021/02/16 11:33] – [Projections] julien.lanfrey
+++ adel:utilisateurs:api-rest:generalites [2021/02/16 13:06] (Version actuelle) – supprimée julien.lanfrey
@@ Ligne 1: / Ligne 1: @@
-====== Critères communs ======
-Certaines routes proposent des paramètres d'entrée communs.
-===== Projections =====
-Au niveau des paramètres d'entrée, figure la plupart du temps, un paramètre facultatif nommé "projection". Ce paramètre permet de préciser ce que l'on souhaite obtenir en réponse.
-Si vous testez les différentes routes, vous remarquerez que les informations qu'elles retournent sont toujours minimalistes. Si vous saisissez "huge" comme valeur, vous pourrez voir que les données obtenus sont plus complètes avec notamment les coordonnées, les descriptions publiques, privées, les mots-clés, etc.
-Vous pouvez ainsi moduler vos appels à l'API en précisant "huge" au niveau de la projection selon que vous avez besoin d'informations complètes ou pas. Les requêtes effectuées avec la projection "huge" sont donc plus lourdes et peuvent prendre plus de temps. Cet aspect est à prendre en compte selon l'usage que vous faites de l'API.