L'anatomie d'une requête API

Introduction aux API en Python

Chris Ramakers

Engineering Manager

Que sont les URL ?

  • URL = Uniform Resource Locator
  • Adresse structurée vers ressource d’API
  • Personnaliser URL pour interagir avec ressources API spécifiques
http://350.5th-ave.com/unit/243
Introduction aux API en Python

Décortiquer l’URL

Un schéma montrant différentes parties d’une URL : Protocole (http://), domaine (350.5th-ave.com), port (:80), chemin (/unit/243) et requête (?floor=77).

  • Protocole = le moyen de transport
  • Domaine = adresse postale des bureaux
  • Port = porte ou entrée à utiliser pour entrer dans bâtiment
  • Chemin = unité de bureau spécifique à l’intérieur bâtiment
  • Requête = instructions supplémentaires
Introduction aux API en Python

Ajouter paramètres requête avec requests

# Append the query parameter to the URL string
response = requests.get('http://350.5th-ave.com/unit/243?floor=77&elevator=True')
print(response.url)

http://350.5th-ave.com/unit/243?floor=77&elevator=True
  • Argument params pour ajouter paramètres requête
# Create dictionary
query_params = {'floor': 77, 'elevator': True}
# Pass the dictionary using the `params` argument
response = requests.get('http://350.5th-ave.com/unit/243', params=query_params)
print(response.url)

http://350.5th-ave.com/unit/243?floor=77&elevator=True
Introduction aux API en Python

Verbes HTTP

  • Destination : Unité 243 des bureaux du 350 5e Avenue
  • URL : http://350.5th-ave.com/unit/243

Actions

Verbe Action Description
GET Lire Vérifier le contenu de la boîte aux lettres
POST Créer Déposer nouveau package dans boîte aux lettres
PUT Mettre à jour Remplacer packages par un nouveau
DELETE Supprimer Retirer tous les colis boîte aux lettres
1 9 verbes HTTP au total, mais pour les API REST simples, seuls ces 4 sont pertinents
Introduction aux API en Python

Envoi données via POST et PUT

# GET = Retrieve a resource
response = requests.get('http://350.5th-ave.com/unit/243')

# POST = Create a resource
response = requests.post('http://350.5th-ave.com/unit/243', data={"key": "value"})
# PUT = Update an existing resource
response = requests.put('http://350.5th-ave.com/unit/243', data={"key": "value"})

# DELETE = Remove a resource
response = requests.delete('http://350.5th-ave.com/unit/243')
  • Chaque verbe a sa propre méthode dans le package requests
  • Argument data pour transmettre données à requête POST ou PUT.
Introduction aux API en Python

Passons à la pratique !

Introduction aux API en Python

Preparing Video For Download...