Est-ce que vous voulez que votre API soit facilement utilisable?

Est-ce que vous voulez que votre API soit facilement utilisable?

Si vous souhaitez que votre API soit facilement utilisable et que les développeurs qui auront à la consommer ne vous fagocitent pas votre temps pour comprendre comment l’utiliser, il est INDISPENSABLE de fournir une documentation claire et précise. Vous aurez donc à documenter :

Quel est le serveur de l’API?

Pour développer une API, il faut un serveur et un client. Le serveur fournit et exécute le programme de l’API . Il attend qu’on lui envoi une requête pour lui demander des données. Le client est un programme distinct qui demande et reçoit les données transmises par l’API.

Quelle est la règle de l’API REST?

Par exemple, une règle stipule qu’un lien vers une URL doit renvoyer des informations. Chaque URL est connue sous le nom de demande, tandis que les données renvoyées sont appelées réponse. L’API REST décompose une transaction pour générer une séquence de petits composants.

Quel est le client de l’API?

Le serveur fournit et exécute le programme de l’API . Il attend qu’on lui envoi une requête pour lui demander des données. Le client est un programme distinct qui demande et reçoit les données transmises par l’API. Ce client peut être un site web, une application, une machine, un logiciel métier, un smartphone, etc…

Quel est le numéro de version de l’API?

Comme toute solution informatique, votre API devrait connaître des évolutions, et donc des versions. Il est important d’indiquer aux développeurs qui consomment votre API la façon dont ils peuvent spécifier la version de l’API qu’ils appellent. Une méthode largement utilisée est d’indiquer le numéro de version dans le PATH de l’URL.

Est-ce que la personne qui appelle votre API a été identifiée?

Une fois que la personne qui appelle votre API a été identifiée, l’autorisation consiste à savoir ce que cette personne a le droit de faire.

Comment augmenter l’utilisabilité de votre API?

L’utilisabilité de votre API pourra être augmentée par l’ajout de fonctionnalités telles que les filtres, le tri ou la pagination. Si l’on compare les filtres, tri ou pagination au langage SQL, les filtres correspondent à la clause « where », le tri correspond à la clause « sort by » et la pagination correspond aux clauses « limit offset ».