L'API OptiSigns est organisée autour de GraphQL. GraphQL est un langage de requête pour API, il fournit une description complète et compréhensible des données dans l'API, donne aux clients le pouvoir de demander exactement ce dont ils ont besoin et rien de plus, facilite l'évolution des API au fil du temps et permet l'utilisation d'outils de développement puissants.
Pourquoi GraphQL
Un seul point de terminaison API
Les API GraphQL sont organisées en termes de types et de champs, et non de points de terminaison. Accédez à toutes les capacités de vos données depuis un seul point de terminaison. GraphQL utilise des types pour s'assurer que les applications ne demandent que ce qui est possible et fournit des erreurs claires et utiles. Les applications peuvent utiliser des types pour éviter d'écrire du code d'analyse manuel.
Obtenir plusieurs ressources en une seule requête
Les requêtes GraphQL accèdent non seulement aux propriétés d'une ressource, mais suivent également facilement les références entre elles. Alors que les API REST typiques nécessitent le chargement à partir de plusieurs URL, les API GraphQL obtiennent toutes les données dont votre application a besoin en une seule requête. Les applications utilisant GraphQL peuvent être rapides même sur des connexions réseau mobiles lentes.
Pas de sur-récupération ni de sous-récupération
Envoyez une requête GraphQL à votre API et obtenez exactement ce dont vous avez besoin, ni plus ni moins. Les requêtes GraphQL renvoient toujours des résultats prévisibles. Les applications utilisant GraphQL sont rapides et stables car elles contrôlent les données qu'elles obtiennent, et non le serveur.
Pas de versioning
De nouveaux champs et types peuvent être ajoutés à l'API GraphQL sans impacter les requêtes existantes. Les champs obsolètes peuvent être dépréciés et cachés des outils. En utilisant une version unique évolutive, les API GraphQL donnent aux applications un accès continu aux nouvelles fonctionnalités et encouragent un code serveur plus propre et plus maintenable.
Point de terminaison de l'API OptiSigns
L'API GraphQL est accessible via le point de terminaison.
https://graphql-gateway.optisigns.com
Nous proposons également un IDE GraphQL basé sur le web pour accéder à notre API.
https://graphql-gateway.optisigns.com/graphql
Article suivant - Générer et gérer la clé API