Aplicaciones Prácticas y Mejores Prácticas
Ahora que has aprendido a establecer varios tipos de encabezados personalizados, exploremos algunas aplicaciones prácticas y las mejores prácticas para trabajar con encabezados en escenarios del mundo real.
Envío y Recepción de Datos JSON
Al trabajar con API modernas, JSON es el formato de datos más común. Veamos cómo establecer correctamente los encabezados para las solicitudes JSON:
- Crea un nuevo archivo llamado
json_requests.py
- Agrega el siguiente código:
import requests
import json
url = 'https://httpbin.org/post' ## This endpoint accepts POST requests
## Data to send
data = {
'name': 'John Doe',
'email': 'john@example.com',
'message': 'Hello, world!'
}
## Set appropriate headers for JSON
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json'
}
## Method 1: Using the json parameter (recommended)
print("Method 1: Using the json parameter")
response = requests.post(url, json=data, headers=headers)
print(f"Status Code: {response.status_code}")
print(response.json()['headers']) ## Show the headers received
print(f"\nData sent (as received by server): {response.json()['json']}")
## Method 2: Manually converting to JSON
print("\nMethod 2: Manually converting to JSON")
json_data = json.dumps(data)
response = requests.post(url, data=json_data, headers=headers)
print(f"Status Code: {response.status_code}")
print(response.json()['headers']) ## Show the headers received
print(f"\nData sent (as received by server): {response.json()['json']}")
- Ejecuta el script:
python json_requests.py
Deberías ver una salida similar a:
Method 1: Using the json parameter
Status Code: 200
{'Accept': 'application/json', 'Accept-Encoding': 'gzip, deflate', 'Content-Length': '72', 'Content-Type': 'application/json', 'Host': 'httpbin.org', 'X-Amzn-Trace-Id': 'Root=1-6430ab12-abc123def456'}
Data sent (as received by server): {'name': 'John Doe', 'email': 'john@example.com', 'message': 'Hello, world!'}
Method 2: Manually converting to JSON
Status Code: 200
{'Accept': 'application/json', 'Accept-Encoding': 'gzip, deflate', 'Content-Length': '72', 'Content-Type': 'application/json', 'Host': 'httpbin.org', 'X-Amzn-Trace-Id': 'Root=1-6430ab13-abc123def456'}
Data sent (as received by server): {'name': 'John Doe', 'email': 'john@example.com', 'message': 'Hello, world!'}
Ten en cuenta que ambos métodos funcionan, pero el Método 1 es más conveniente porque la biblioteca Requests maneja la conversión JSON por ti.
Creación de una Sesión Reutilizable con Encabezados Predeterminados
Si necesitas hacer múltiples solicitudes con los mismos encabezados, usar un objeto Session puede ahorrar tiempo y hacer que tu código sea más limpio:
- Crea un nuevo archivo llamado
session_headers.py
- Agrega el siguiente código:
import requests
## Create a session object
session = requests.Session()
## Set default headers for all requests made with this session
session.headers.update({
'User-Agent': 'MyCustomApp/1.0',
'Accept-Language': 'en-US,en;q=0.9',
'X-API-Key': 'my_session_api_key'
})
## Make a request using the session - it will include our default headers
print("First request with session:")
response = session.get('https://httpbin.org/headers')
print(response.json())
## Add a custom header just for this request
print("\nSecond request with additional header:")
response = session.get('https://httpbin.org/headers',
headers={'X-Custom-Header': 'Just for this request'})
print(response.json())
## Original headers remain unchanged for future requests
print("\nThird request (original headers only):")
response = session.get('https://httpbin.org/headers')
print(response.json())
- Ejecuta el script:
python session_headers.py
Deberías ver una salida similar a:
First request with session:
{'headers': {'Accept': '*/*', 'Accept-Encoding': 'gzip, deflate', 'Accept-Language': 'en-US,en;q=0.9', 'Host': 'httpbin.org', 'User-Agent': 'MyCustomApp/1.0', 'X-API-Key': 'my_session_api_key', 'X-Amzn-Trace-Id': 'Root=1-6430ab45-abc123def456'}}
Second request with additional header:
{'headers': {'Accept': '*/*', 'Accept-Encoding': 'gzip, deflate', 'Accept-Language': 'en-US,en;q=0.9', 'Host': 'httpbin.org', 'User-Agent': 'MyCustomApp/1.0', 'X-API-Key': 'my_session_api_key', 'X-Custom-Header': 'Just for this request', 'X-Amzn-Trace-Id': 'Root=1-6430ab46-abc123def456'}}
Third request (original headers only):
{'headers': {'Accept': '*/*', 'Accept-Encoding': 'gzip, deflate', 'Accept-Language': 'en-US,en;q=0.9', 'Host': 'httpbin.org', 'User-Agent': 'MyCustomApp/1.0', 'X-API-Key': 'my_session_api_key', 'X-Amzn-Trace-Id': 'Root=1-6430ab47-abc123def456'}}
Usar sesiones es una mejor práctica por varias razones:
- Rendimiento mejorado (agrupación de conexiones)
- Encabezados consistentes en todas las solicitudes
- Manejo automático de cookies
- Capacidad de agregar personalización por solicitud cuando sea necesario
Mejores Prácticas para Trabajar con Encabezados
Para concluir, aquí hay algunas mejores prácticas a seguir al trabajar con encabezados HTTP:
- Usa Objetos Session para múltiples solicitudes al mismo dominio
- Establece los Encabezados Content-Type correctamente para los datos que estás enviando
- Maneja la Autenticación Correctamente - usa la autenticación integrada cuando sea posible
- Mantén la Información Sensible Segura - no codifiques API keys o tokens de forma estática
- Sigue la Documentación de la API cuidadosamente para los encabezados requeridos
Aquí hay un ejemplo final que demuestra estas mejores prácticas:
- Crea un nuevo archivo llamado
best_practices.py
- Agrega el siguiente código:
import requests
import os
## In a real application, get these from environment variables or a secure configuration
## For this example, we're keeping it simple
API_KEY = os.environ.get('API_KEY', 'default_api_key')
BASE_URL = 'https://httpbin.org'
def create_api_client():
"""Create a reusable session with default headers."""
session = requests.Session()
## Set common headers
session.headers.update({
'User-Agent': 'MyApp/1.0',
'X-API-Key': API_KEY,
'Accept': 'application/json'
})
return session
def get_data(client, endpoint):
"""Make a GET request to the specified endpoint."""
url = f"{BASE_URL}/{endpoint}"
response = client.get(url)
return response.json()
def post_data(client, endpoint, data):
"""Make a POST request with JSON data."""
url = f"{BASE_URL}/{endpoint}"
response = client.post(url, json=data)
return response.json()
## Usage example
def main():
## Create the API client
client = create_api_client()
## GET request example
print("Making GET request...")
get_response = get_data(client, 'headers')
print(f"Headers sent: {get_response['headers']}")
## POST request example
print("\nMaking POST request...")
data = {'name': 'John', 'age': 30}
post_response = post_data(client, 'post', data)
print(f"Data received by server: {post_response['json']}")
if __name__ == '__main__':
main()
- Ejecuta el script:
python best_practices.py
Deberías ver una salida similar a:
Making GET request...
Headers sent: {'Accept': 'application/json', 'Accept-Encoding': 'gzip, deflate', 'Host': 'httpbin.org', 'User-Agent': 'MyApp/1.0', 'X-API-Key': 'default_api_key', 'X-Amzn-Trace-Id': 'Root=1-6430ab78-abc123def456'}
Making POST request...
Data received by server: {'name': 'John', 'age': 30}
Este ejemplo demuestra un enfoque estructurado para realizar solicitudes HTTP con encabezados personalizados, siguiendo las mejores prácticas como la creación de sesiones reutilizables, la organización del código en funciones y la evitación de información sensible codificada de forma estática.
