- Mantén la consistencia: URL/headers/autenticación/códigos de estado..
- Usa el formato de fecha ISO8601 UTC
- Solo los endpoints públicos deben ser excepción de autenticación. Todos los demás deben requerir autenticación
- Proporciona un endpoint de health check
- Versionado de la API
- Aplica autenticación con API keys
- Usa métodos y códigos de estado HTTP razonables
- Usa nombres simples para cada endpoint que se expliquen por sí solos
- Usa respuestas de error estándar
- Devuelve el recurso creado en un POST
- PATCH en lugar de PUT
- Sé lo más específico posible
- Usa paginación
- Haz que cada recurso sea extensible (diseña para que también pueda devolver información adicional mediante query params como
expand)
2 comentarios
Últimamente me he topado mucho con contenido relacionado por todos lados, y recomiendo The Design of Web APIs by Arnaud Lauret. Por el título y la portada, uno podría confundirlo con una especie de libro de analogías sencillas sobre internet, pero es un muy buen libro en el que destaca la visión del autor sobre el diseño de APIs, ya que se dedica profesionalmente a eso.
Guía de Microsoft para API REST
Guía de Stack Overflow para API REST