Limitación vs. Control de velocidad | Diferencias esenciales

Las API son la columna vertebral esencial de nuestra web moderna, permitiendo que diferentes aplicaciones se comuniquen e intercambien datos entre sí. Con cada aplicación teniendo su nicho, algunas personas maliciosas tienden a abusar de estas útiles aplicaciones, impactando negativamente la experiencia de otros usuarios. Sin embargo, ¿y si hubiera una forma de evitar esto?

Para averiguar cuál es la diferencia entre la limitación y la regulación de la velocidad, las definiremos individualmente.

¿Qué es la limitación?

En el contexto de las APIs, la limitación se considera un enfoque dinámico para gestionar el acceso a la API y evitar la sobrecarga de la API. La limitación de las APIs regula el flujo de solicitudes entrantes para garantizar la estabilidad y el rendimiento de la API.

Características clave de la limitación de la API

1. Ajuste dinámico:

• A diferencia de los límites fijos de la limitación de velocidad, la limitación ajusta dinámicamente los tiempos de respuesta en función de las condiciones del tráfico en tiempo real. Imagina una autopista con límites de velocidad variables. El tráfico activa ajustes (limitación) para mantener un flujo suave (estabilidad de la API).

2. Técnicas y algoritmos:

• Cubo con fugas: Las solicitudes entrantes llenan un cubo virtual con una pequeña fuga en la parte inferior. Los tiempos de respuesta aumentan (la fuga se ralentiza) a medida que el cubo se llena (el sistema se acerca a la sobrecarga) y viceversa.
• Cubos de tokens: Los usuarios tienen un número limitado de tokens (solicitudes) por período de tiempo. Cada solicitud consume un token. Si no hay tokens disponibles (el cubo está vacío), la solicitud se limita hasta que se repone un token.

3. Opciones de configuración:

• Granularidad: La limitación se puede aplicar globalmente o a puntos finales de API específicos en función de su uso de recursos.
• Umbrales: Los umbrales personalizables determinan cuándo entra en vigor la limitación. Estos pueden basarse en factores como las solicitudes simultáneas o la utilización de recursos.
• Ventanas de tiempo: El comportamiento de la limitación se puede configurar para ventanas de tiempo específicas (por ejemplo, horas pico).

4. Mecanismos de respuesta:

• Ralentización: El enfoque más común, que aumenta los tiempos de respuesta para las solicitudes posteriores.
• Códigos de error: Devolución de códigos de error HTTP específicos (por ejemplo, 429 Demasiadas solicitudes) para indicar la limitación y las posibles opciones de reintento.
• Colas de espera: Retención temporal de solicitudes en una cola hasta que los recursos estén disponibles.

5. Características avanzadas:

• Lista blanca: Concesión a usuarios o aplicaciones específicos de la exención de la limitación para operaciones críticas.
• Lista negra: Limitación más agresiva para los usuarios que exhiben un comportamiento abusivo.
• Integración con la supervisión: Los parámetros de limitación se pueden ajustar dinámicamente en función de los datos de uso de la API en tiempo real.

Ejemplo de código de limitación de API

1. Limitación simple de la API con retardo (Python):

def handle_request(user_id):
  # Simular la comprobación de un contador de recursos compartidos
  if resource_counter > threshold:
    time.sleep(delay_time)  # Limitar introduciendo un retardo
  # Procesar la lógica de la solicitud aquí...

2. Limitación del cubo de tokens para solicitudes de API (Python)

from threading import Lock

class TokenBucket:
  """
  Una clase simple de cubo de tokens para la limitación de velocidad.
  """
  def __init__(self, capacity, refill_rate):
    """
    Inicializar el cubo de tokens con una capacidad y una tasa de recarga específicas.

    Args:
      capacity (int): El número máximo de tokens que puede contener el cubo.
      refill_rate (float): La tasa a la que se añaden tokens al cubo (tokens por segundo).
    """
    self.capacity = capacity
    self.refill_rate = refill_rate
    self.tokens = capacity  # Empezar con un cubo lleno
    self.last_refill_time = time.time()
    self.lock = Lock()

  def consume(self, amount):
    """
    Intenta consumir un número especificado de tokens del cubo.

    Args:
      amount (int): El número de tokens que se van a consumir.

    Returns:
      bool: True si los tokens se consumieron correctamente, False en caso contrario.
    """
    with self.lock:
      self._refill()
      if self.tokens >= amount:
        self.tokens -= amount
        return True
      return False

  def _refill(self):
    """
    Recarga el cubo en función del tiempo transcurrido y la tasa de recarga.
    """
    now = time.time()
    elapsed_time = now - self.last_refill_time
    self.tokens = min(self.capacity, self.tokens + (elapsed_time * self.refill_rate))
    self.last_refill_time = now

# Ejemplo de uso
bucket = TokenBucket(capacity=5, refill_rate=1)  # 5 tokens, recargados a 1 token/segundo

def access_api():
  # Simular la lógica de la solicitud de API aquí...
  print("Accediendo a la API...")

if bucket.consume(2):
  access_api()
else:
  print("Solicitud limitada, ¡no hay suficientes tokens!")

# Inténtalo de nuevo después de un breve retardo
time.sleep(1)

if bucket.consume(1):
  access_api()
else:
  print("Solicitud limitada, ¡no hay suficientes tokens!")

Explicación del código (paso a paso):

1. Primero define una clase TokenBucket que gestione el grupo de tokens
2. Toma la capacidad (tokens máximos) y la tasa de recarga (tokens por segundo) como argumentos.
3. El método consume intenta eliminar un número especificado de tokens del cubo.
4. Llama al método privado _refill para asegurarse de que el cubo se actualiza en función del tiempo transcurrido.
5. Si hay suficientes tokens, se consumen: el método devuelve True
6. De lo contrario, el método devuelve False: indica la limitación.

¿Qué es la limitación de velocidad?

En el contexto de las APIs, la limitación de velocidad se refiere a una restricción establecida sobre el número de solicitudes que un usuario o aplicación puede realizar dentro de un período específico. Imagínalo como una taquilla en una atracción popular, donde solo se permite un cierto número de solicitudes por minuto.

Características clave de la limitación de velocidad de la API

1. Configuración de límites:

Límites de solicitud: Los proveedores de API definen el número máximo de solicitudes permitidas por usuario o aplicación dentro de una ventana de tiempo específica (por ejemplo, 100 solicitudes por hora). Estos límites pueden basarse en factores como:

• Niveles de usuario: Los planes gratuitos frente a los de pago pueden tener diferentes límites.
• Puntos finales de la API: Diferentes funcionalidades pueden tener diferentes requisitos de recursos, lo que lleva a diferentes límites.

Ventanas de tiempo: Los límites se aplican dentro de plazos específicos, normalmente segundos, minutos u horas. Esto permite ráfagas controladas de actividad al tiempo que evita la sobrecarga sostenida.

2. Mecanismos de conteo:

Identificación del usuario: Las solicitudes se asocian con usuarios o aplicaciones. Esto se puede lograr a través de:

• Claves de API: Identificadores únicos proporcionados a los desarrolladores para la autenticación y el seguimiento del uso.
• Direcciones IP: Aunque son menos seguras, las direcciones IP se pueden utilizar para la limitación de velocidad básica.

Contadores de solicitudes: La API realiza un seguimiento del número de solicitudes recibidas de cada usuario/aplicación dentro de la ventana de tiempo actual.

3. Estrategias de aplicación:

• Bloqueo: Cuando un usuario alcanza el límite, sus solicitudes posteriores pueden bloquearse por completo hasta que se restablezca la ventana de tiempo. Este es un enfoque más estricto adecuado para prevenir el abuso.
• Limitación: La limitación, que a menudo se utiliza junto con la limitación de velocidad, ralentiza las solicitudes posteriores en lugar de bloquearlas por completo. Esto permite cierto nivel de acceso al tiempo que evita la sobrecarga. (La limitación es un concepto separado, pero se puede utilizar junto con la limitación de velocidad)

4. Características avanzadas:

• Límites de ráfaga: Asignaciones a corto plazo para exceder el límite de velocidad promedio para acomodar ráfagas de actividad. Esto ofrece flexibilidad para casos de uso legítimos.
• Cubo con fugas: Un enfoque metafórico donde las solicitudes son como agua que llena un cubo con una pequeña fuga. La fuga representa el límite de velocidad. Las solicitudes se procesan siempre que el cubo no esté lleno.
• Cubos de tokens: A los usuarios se les asigna un conjunto de tokens (solicitudes) que se reponen con el tiempo. Las solicitudes consumen tokens y los usuarios se limitan si no hay tokens disponibles.

5. Comunicación y supervisión:

• Documentación de la API: La documentación clara describe los límites de velocidad, incluidos los límites específicos, las ventanas de tiempo y los métodos de aplicación.
• Supervisión y alertas: Los proveedores de API supervisan los patrones de uso y ajustan los límites de velocidad según sea necesario para mantener la estabilidad.

Ejemplos de código de limitación de velocidad de la API

1. Seguimiento de límites y ventanas de tiempo (Python):

# Simular el almacenamiento de información de límite de velocidad de la API recuperada de la documentación de la API
rate_limit = 100  # Solicitudes por hora
time_window = 3600  # Segundos en una hora

last_request_time = None

def make_api_request():
  global last_request_time

  # Comprobar si está dentro de la ventana de tiempo y si quedan suficientes solicitudes (hipotético)
  if last_request_time is None or (time.time() - last_request_time) >= time_window:
    # Realizar la solicitud de API
    last_request_time = time.time()
    # ... (lógica de solicitud de API)
  else:
    print("Se ha alcanzado el límite de velocidad de la API, esperando el restablecimiento...")
    # Implementar la estrategia de retroceso (ver el punto 3)

# Ejemplo de uso
make_api_request()

El ejemplo de código anterior muestra una situación en la que se almacena la información de límite de velocidad recuperada (solicitudes y ventana de tiempo) y se realiza un seguimiento de la hora de la última solicitud. A continuación, el código comprueba si se puede realizar una solicitud en función del tiempo restante y las solicitudes permitidas dentro de la ventana.

2. Utilización de los encabezados de respuesta de la API (Python):

import requests

def make_api_request():
  response = requests.get("https://api.example.com/data")
  if response.status_code == 429:  # Código de límite de velocidad excedido
    # Extraer información de límite de velocidad de los encabezados (X-RateLimit-Remaining, X-RateLimit-Reset)
    # Implementar la estrategia de retroceso (ver el punto 3)
  else:
    # Procesar la respuesta correcta
    # ...

El ejemplo de código anterior comprueba el código de estado de la respuesta para un código de error de límite de velocidad común 429 e intenta extraer información relevante de los encabezados de la respuesta si se encuentra.

Diferencias resumidas entre la limitación y la limitación de velocidad

Apidog: solicitudes ilimitadas para perfeccionar tu aplicación

Lo único que te impide crear las mejores APIs son las limitaciones de tus herramientas: la mayoría de las herramientas de API actuales tienen muros de pago. Si no pagas, no puedes obtener las características esenciales para el desarrollo de la API. Sin embargo, una herramienta de desarrollo de API va un paso más allá para proporcionar los mejores servicios para los desarrolladores.

Te presentamos Apidog, una herramienta de desarrollo de API todo en uno que facilita cada proceso de desarrollo de API para todo el ciclo de vida de la API. Con Apidog, puedes crear nuevas APIs y modificar APIs preexistentes, y llevar a cabo pruebas, simulaciones y documentación para garantizar que tus APIs funcionen a la perfección.

Creación de APIs con Apidog

Con Apidog, puedes crear APIs por ti mismo. Esto significa que también puedes establecer el propio límite de velocidad de tu API y decidir si quieres limitar tu API con la ayuda de código adicional.

Comienza pulsando el botón Nueva API, como se muestra en la imagen anterior.

A continuación, puedes seleccionar muchas de las características de la API. En esta página, puedes:

• Establecer el método HTTP (GET, POST, PUT o DELETE)
• Establecer la URL de la API (o punto final de la API) para la interacción cliente-servidor
• Incluir uno o varios parámetros para pasarlos en la URL de la API
• Proporcionar una descripción de la funcionalidad que pretende proporcionar la API. Aquí, también puedes describir el límite de velocidad que planeas implementar en tu API.

Cuantos más detalles puedas proporcionar a la etapa de diseño, más descriptiva será la documentación de tu API, como se muestra en la siguiente sección de este artículo.

Asegúrate de incluir también si hay algún límite de velocidad impuesto a la API, ya que los usuarios necesitarán ese conocimiento para trabajar con la API.

Para proporcionar algo de ayuda en la creación de APIs en caso de que sea la primera vez que creas una, puedes considerar la posibilidad de leer estos artículos.

Una vez que hayas finalizado todas las necesidades básicas para realizar una solicitud, puedes intentar realizar una solicitud haciendo clic en Enviar. A continuación, deberías recibir una respuesta en la parte inferior de la ventana de Apidog, como se muestra en la imagen anterior.

La interfaz de usuario sencilla e intuitiva permite a los usuarios ver fácilmente la respuesta obtenida de la solicitud. También es importante comprender la estructura de la respuesta, ya que necesitas hacer coincidir el código tanto en el lado del cliente como en el del servidor.

Genera documentación de API descriptiva con Apidog

Con Apidog, puedes crear rápidamente documentación de API que incluya todo lo que los desarrolladores de software necesitan con solo unos pocos clics.

Flecha 1: primero, pulsa el botón Compartir en el lado izquierdo de la ventana de la aplicación Apidog. A continuación, deberías poder ver la página "Documentos compartidos", que debería estar vacía.

Flecha 2: pulsa el botón + Nuevo debajo de Sin datos para empezar a crear tu primera documentación de API de Apidog.

Selecciona e incluye propiedades importantes de la documentación de la API

Apidog proporciona a los desarrolladores la opción de elegir las características de la documentación de la API, como quién puede ver la documentación de tu API y establecer una contraseña de archivo, para que solo las personas u organizaciones elegidas puedan verla.

Ver o compartir la documentación de tu API

Apidog compila los detalles del proyecto de tu API en una documentación de API que se puede ver a través de una URL de sitio web. ¡Todo lo que tienes que hacer es distribuir la URL para que otros puedan ver la documentación de tu API!

Si se requieren más detalles, lee este artículo sobre cómo generar documentación de API utilizando Apidog:

Conclusión

La limitación y la regulación de la velocidad son herramientas esenciales para gestionar el acceso a la API y garantizar un funcionamiento sin problemas. Si bien comparten el objetivo común de prevenir la sobrecarga, difieren en su enfoque.

La limitación de velocidad actúa como un estricto guardián, estableciendo un límite estricto en las solicitudes dentro de un período de tiempo. Esto prioriza la equidad y previene el abuso. La limitación, por otro lado, funciona como un interruptor de atenuación, ajustando dinámicamente los tiempos de respuesta en función del tráfico. Esto garantiza la estabilidad y el rendimiento al manejar con elegancia los aumentos repentinos en las solicitudes.

Comprender las fortalezas de cada enfoque permite a los proveedores de API crear un sistema de control de acceso robusto que equilibre las necesidades del usuario con la capacidad de la API, lo que lleva a una experiencia segura y de alto rendimiento para todos.

Con Apidog, no tienes que preocuparte por las solicitudes limitadas. También puedes importar las APIs que quieras entender y analizarlas utilizando el diseño sencillo pero intuitivo de Apidog. ¡Comienza hoy mismo tu viaje de desarrollo de API con Apidog!