Paramètres de Requête (Query Parameters)
Les paramètres de requête sont ajoutés à la fin de l'URL après un point d'interrogation ?. Ils sont généralement utilisés pour filtrer, trier ou paginer les résultats.
- Format :
?param1=value1¶m2=value2 - Exemple :
GET /api/users?name=John&age=30
| Paramètre | Description |
|---|---|
name |
Filtre les utilisateurs par nom. |
age |
Filtre les utilisateurs par âge. |
page |
Spécifie le numéro de la page pour la pagination. |
limit |
Limite le nombre de résultats retournés. |
sort |
Trie les résultats selon un critère spécifique. |
En-têtes HTTP (Headers)
Les en-têtes HTTP sont utilisés pour transmettre des métadonnées supplémentaires avec les requêtes et les réponses. Ils peuvent inclure des informations sur le type de contenu, l'authentification, le cache, etc.
| En-tête | Description |
|---|---|
Host |
Spécifie le nom de domaine du serveur. |
Content-Type |
Indique le type de contenu du corps de la requête (par exemple, application/json). |
Authorization |
Contient les informations d'authentification pour accéder à une ressource protégée. |
Accept |
Indique les types de contenu que le client peut comprendre. |
User-Agent |
Contient des informations sur le client (navigateur, système d'exploitation). |
Cache-Control |
Spécifie les directives de mise en cache pour la requête ou la réponse. |
Cookie |
Contient des cookies stockés précédemment envoyés par le serveur. |
Paramètres de Corps (Body Parameters)
Les paramètres de corps sont inclus dans le corps de la requête et sont généralement utilisés avec les méthodes POST et PUT pour envoyer des données au serveur.
- Format : Généralement au format JSON ou XML.
- Exemple :
{ "name": "John Doe", "email": "john.doe@example.com", "age": 30 }
| Paramètre | Description |
|---|---|
name |
Le nom de l'utilisateur. |
email |
L'adresse e-mail de l'utilisateur. |
age |
L'âge de l'utilisateur. |
Paramètres de Chemin (Path Parameters)
Les paramètres de chemin sont inclus dans l'URL elle-même et sont utilisés pour identifier une ressource spécifique.
- Format :
/users/{id} - Exemple :
GET /api/users/123
| Paramètre | Description |
|---|---|
id |
L'identifiant unique de l'utilisateur. |
Ces paramètres permettent de transmettre des informations spécifiques et contextuelles avec les requêtes HTTP, facilitant ainsi la communication entre les clients et les serveurs dans le cadre des API REST.