Principios de Diseño de APIs
Domina los principios de diseño de APIs REST y GraphQL para construir APIs intuitivas, escalables y mantenibles que encanten a los desarrolladores y resistan el paso del tiempo.
Cuándo Usar Esta Habilidad
- Diseñar nuevas APIs REST o GraphQL
- Refactorizar APIs existentes para mejorar su usabilidad
- Establecer estándares de diseño de API para tu equipo
- Revisar especificaciones de API antes de la implementación
- Migrar entre paradigmas de API (REST a GraphQL, etc.)
- Crear documentación de API amigable para desarrolladores
- Optimizar APIs para casos de uso específicos (móvil, integraciones de terceros)
Conceptos Clave
1. Principios de Diseño RESTful
Arquitectura Orientada a Recursos
- Los recursos son sustantivos (usuarios, pedidos, productos), no verbos
- Usa métodos HTTP para las acciones (GET, POST, PUT, PATCH, DELETE)
- Las URLs representan jerarquías de recursos
- Convenciones de nomenclatura consistentes
Semántica de Métodos HTTP:
GET: Recuperar recursos (idempotente, seguro)POST: Crear nuevos recursosPUT: Reemplazar recurso completo (idempotente)PATCH: Actualizaciones parciales de recursosDELETE: Eliminar recursos (idempotente)
2. Principios de Diseño GraphQL
Desarrollo Schema-First
- Los Tipos definen tu modelo de dominio
- Queries para leer datos
- Mutaciones para modificar datos
- Suscripciones para actualizaciones en tiempo real
Estructura de Queries:
- Los clientes solicitan exactamente lo que necesitan
- Un solo endpoint, múltiples operaciones
- Esquema fuertemente tipado
- Introspección incorporada
3. Estrategias de Versionado de API
Versionado por URL:
/api/v1/users
/api/v2/users
Versionado por Cabecera:
Accept: application/vnd.api+json; version=1
Versionado por Parámetro de Consulta:
/api/users?version=1
Patrones de Diseño de API REST
Patrón 1: Diseño de Colecciones de Recursos
# Bueno: Endpoints orientados a recursos
GET /api/users # Listar usuarios (con paginación)
POST /api/users # Crear usuario
GET /api/users/{id} # Obtener usuario específico
PUT /api/users/{id} # Reemplazar usuario
PATCH /api/users/{id} # Actualizar campos de usuario
DELETE /api/users/{id} # Eliminar usuario
# Recursos anidados
GET /api/users/{id}/orders # Obtener pedidos de un usuario
POST /api/users/{id}/orders # Crear pedido para un usuario
# Malo: Endpoints orientados a acciones (evitar)
POST /api/createUser
POST /api/getUserById
POST /api/deleteUser
Patrón 2: Paginación y Filtrado
from typing import List, Optional
from pydantic import BaseModel, Field
class PaginationParams(BaseModel):
page: int = Field(1, ge=1, description="Número de página")
page_size: int = Field(20, ge=1, le=100, description="Elementos por página")
class FilterParams(BaseModel):
status: Optional[str] = None
created_after: Optional[str] = None
search: Optional[str] = None
class PaginatedResponse(BaseModel):
items: List[dict]
total: int
page: int
page_size: int
pages: int
@property
def has_next(self) -> bool:
return self.page < self.pages
@property
def has_prev(self) -> bool:
return self.page > 1
# Ejemplo de endpoint FastAPI
from fastapi import FastAPI, Query, Depends
app = FastAPI()
@app.get("/api/users", response_model=PaginatedResponse)
async def list_users(
page: int = Query(1, ge=1),
page_size: int = Query(20, ge=1, le=100),
status: Optional[str] = Query(None),
search: Optional[str] = Query(None)
):
# Aplicar filtros
query = build_query(status=status, search=search)
# Contar total
total = await count_users(query)
# Obtener página
offset = (page - 1) * page_size
users = await fetch_users(query, limit=page_size, offset=offset)
return PaginatedResponse(
items=users,
total=total,
page=page,
page_size=page_size,
pages=(total + page_size - 1) // page_size
)
Patrón 3: Manejo de Errores y Códigos de Estado
from fastapi import HTTPException, status
from pydantic import BaseModel
class ErrorResponse(BaseModel):
error: str
message: str
details: Optional[dict] = None
timestamp: str
path: str
class ValidationErrorDetail(BaseModel):
field: str
message: str
value: Any
# Respuestas de error consistentes
STATUS_CODES = {
"success": 200,
"created": 201,
"no_content": 204,
"bad_request": 400,
"unauthorized": 401,
"forbidden": 403,
"not_found": 404,
"conflict": 409,
"unprocessable": 422,
"internal_error": 500
}
def raise_not_found(resource: str, id: str):
raise HTTPException(
status_code=status.HTTP_404_NOT_FOUND,
detail={
"error": "NotFound",
"message": f"{resource} no encontrado",
"details": {"id": id}
}
)
def raise_validation_error(errors: List[ValidationErrorDetail]):
raise HTTPException(
status_code=status.HTTP_422_UNPROCESSABLE_ENTITY,
detail={
"error": "ValidationError",
"message": "La validación de la solicitud falló",
"details": {"errors": [e.dict() for e in errors]}
}
)
# Ejemplo de uso
@app.get("/api/users/{user_id}")
async def get_user(user_id: str):
user = await fetch_user(user_id)
if not user:
raise_not_found("Usuario", user_id)
return user
Patrón 4: HATEOAS (Hipermedia como Motor del Estado de la Aplicación)
class UserResponse(BaseModel):
id: str
name: str
email: str
_links: dict
@classmethod
def from_user(cls, user: User, base_url: str):
return cls(
id=user.id,
name=user.name,
email=user.email,
_links={
"self": {"href": f"{base_url}/api/users/{user.id}"},
"orders": {"href": f"{base_url}/api/users/{user.id}/orders"},
"update": {
"href": f"{base_url}/api/users/{user.id}",
"method": "PATCH"
},
"delete": {
"href": f"{base_url}/api/users/{user.id}",
"method": "DELETE"
}
}
)
Patrones de Diseño GraphQL
Patrón 1: Diseño de Esquema
# schema.graphql
# Definiciones de tipo claras
type User {
id: ID!
email: String!
name: String!
createdAt: DateTime!
# Relaciones
orders(first: Int = 20, after: String, status: OrderStatus): OrderConnection!
profile: UserProfile
}
type Order {
id: ID!
status: OrderStatus!
total: Money!
items: [OrderItem!]!
createdAt: DateTime!
# Referencia inversa
user: User!
}
# Patrón de paginación (estilo Relay)
type OrderConnection {
edges: [OrderEdge!]!
pageInfo: PageInfo!
totalCount: Int!
}
type OrderEdge {
node: Order!
cursor: String!
}
type PageInfo {
hasNextPage: Boolean!
hasPreviousPage: Boolean!
startCursor: String
endCursor: String
}
# Enums para seguridad de tipos
enum OrderStatus {
PENDING
CONFIRMED
SHIPPED
DELIVERED
CANCELLED
}
# Escalares personalizados
scalar DateTime
scalar Money
# Raíz de Query
type Query {
user(id: ID!): User
users(first: Int = 20, after: String, search: String): UserConnection!
order(id: ID!): Order
}
# Raíz de Mutation
type Mutation {
createUser(input: CreateUserInput!): CreateUserPayload!
updateUser(input: UpdateUserInput!): UpdateUserPayload!
deleteUser(id: ID!): DeleteUserPayload!
createOrder(input: CreateOrderInput!): CreateOrderPayload!
}
# Tipos de entrada para mutaciones
input CreateUserInput {
email: String!
name: String!
password: String!
}
# Tipos de payload para mutaciones
type CreateUserPayload {
user: User
errors: [Error!]
}
type Error {
field: String
message: String!
}
Patrón 2: Diseño de Resolvers
from typing import Optional, List
from ariadne import QueryType, MutationType, ObjectType
from dataclasses import dataclass
query = QueryType()
mutation = MutationType()
user_type = ObjectType("User")
@query.field("user")
async def resolve_user(obj, info, id: str) -> Optional[dict]:
"""Resuelve un solo usuario por ID."""
return await fetch_user_by_id(id)
@query.field("users")
async def resolve_users(
obj,
info,
first: int = 20,
after: Optional[str] = None,
search: Optional[str] = None
) -> dict:
"""Resuelve lista paginada de usuarios."""
# Decodificar cursor
offset = decode_cursor(after) if after else 0
# Obtener usuarios
users = await fetch_users(
limit=first + 1, # Obtener uno extra para verificar hasNextPage
offset=offset,
search=search
)
# Paginación
has_next = len(users) > first
if has_next:
users = users[:first]
edges = [
{
"node": user,
"cursor": encode_cursor(offset + i)
}
for i, user in enumerate(users)
]
return {
"edges": edges,
"pageInfo": {
"hasNextPage": has_next,
"hasPreviousPage": offset > 0,
"startCursor": edges[0]["cursor"] if edges else None,
"endCursor": edges[-1]["cursor"] if edges else None
},
"totalCount": await count_users(search=search)
}
@user_type.field("orders")
async def resolve_user_orders(user: dict, info, first: int = 20) -> dict:
"""Resuelve pedidos de un usuario (prevención de N+1 con DataLoader)."""
# Usar DataLoader para agrupar solicitudes
loader = info.context["loaders"]["orders_by_user"]
orders = await loader.load(user["id"])
return paginate_orders(orders, first)
@mutation.field("createUser")
async def resolve_create_user(obj, info, input: dict) -> dict:
"""Crea un nuevo usuario."""
try:
# Validar entrada
validate_user_input(input)
# Crear usuario
user = await create_user(
email=input["email"],
name=input["name"],
password=hash_password(input["password"])
)
return {
"user": user,
"errors": []
}
except ValidationError as e:
return {
"user": None,
"errors": [{"field": e.field, "message": e.message}]
}
Patrón 3: DataLoader (Prevención del Problema N+1)
from aiodataloader import DataLoader
from typing import List, Optional
class UserLoader(DataLoader):
"""Carga usuarios por ID de forma agrupada."""
async def batch_load_fn(self, user_ids: List[str]) -> List[Optional[dict]]:
"""Carga múltiples usuarios en una sola consulta."""
users = await fetch_users_by_ids(user_ids)
# Mapear resultados de vuelta al orden de entrada
user_map = {user["id"]: user for user in users}
return [user_map.get(user_id) for user_id in user_ids]
class OrdersByUserLoader(DataLoader):
"""Carga pedidos por ID de usuario de forma agrupada."""
async def batch_load_fn(self, user_ids: List[str]) -> List[List[dict]]:
"""Carga pedidos para múltiples usuarios en una sola consulta."""
orders = await fetch_orders_by_user_ids(user_ids)
# Agrupar pedidos por user_id
orders_by_user = {}
for order in orders:
user_id = order["user_id"]
if user_id not in orders_by_user:
orders_by_user[user_id] = []
orders_by_user[user_id].append(order)
# Devolver en el orden de entrada
return [orders_by_user.get(user_id, []) for user_id in user_ids]
# Configuración de contexto
def create_context():
return {
"loaders": {
"user": UserLoader(),
"orders_by_user": OrdersByUserLoader()
}
}
Mejores Prácticas
APIs REST
- Nomenclatura Consistente: Usa sustantivos en plural para colecciones (
/users, no/user) - Sin Estado: Cada solicitud contiene toda la información necesaria
- Usa Códigos de Estado HTTP Correctamente: 2xx éxito, 4xx errores de cliente, 5xx errores de servidor
- Versiona tu API: Planifica cambios disruptivos desde el primer día
- Paginación: Siempre pagina colecciones grandes
- Límite de Tasa: Protege tu API con límites de tasa
- Documentación: Usa OpenAPI/Swagger para documentación interactiva
APIs GraphQL
- Schema First: Diseña el esquema antes de escribir resolvers
- Evita N+1: Usa DataLoaders para una obtención de datos eficiente
- Validación de Entrada: Valida a nivel de esquema y resolver
- Manejo de Errores: Devuelve errores estructurados en los payloads de mutación
- Paginación: Usa paginación basada en cursores (especificación Relay)
- Deprecación: Usa la directiva
@deprecatedpara una migración gradual - Monitoreo: Rastrea la complejidad de las consultas y el tiempo de ejecución
Errores Comunes
- Sobre-obtención/Sub-obtención (REST): Solucionado en GraphQL pero requiere DataLoaders
- Cambios Disruptivos: Versiona las APIs o usa estrategias de deprecación
- Formatos de Error Inconsistentes: Estandariza las respuestas de error
- Límites de Tasa Ausentes: Las APIs sin límites son vulnerables al abuso
- Documentación Deficiente: Las APIs sin documentación frustran a los desarrolladores
- Ignorar la Semántica HTTP: Usar POST para operaciones idempotentes rompe las expectativas
- Acoplamiento Fuerte: La estructura de la API no debe reflejar el esquema de la base de datos
Recursos
- references/rest-best-practices.md: Guía completa de diseño de API REST
- references/graphql-schema-design.md: Patrones y anti-patrones de esquemas GraphQL
- references/api-versioning-strategies.md: Enfoques de versionado y rutas de migración
- assets/rest-api-template.py: Plantilla de API REST FastAPI
- assets/graphql-schema-template.graphql: Ejemplo completo de esquema GraphQL
- assets/api-design-checklist.md: Lista de verificación de revisión previa a la implementación
- scripts/openapi-generator.py: Genera especificaciones OpenAPI desde el código