Buenas prácticas API Rest
Ir a la navegación
Ir a la búsqueda
General
- Usa SSL en todos lados, sin excepciones.
- Tener una buena documentación.
- Versiona a través de la URL.
- Usa parámetros de consulta para filtros avanzados, ordenamiento y búsqueda.
- Provee una forma de limitar cuáles campos son devueltos desde la API.
- Devuelve algo útil de las peticiones POST, PATCH & PUT.
- Usa JSON donde sea posible, XML sólo si tienes la obligación.
- Deberías usar camelCase con JSON, pero snake_case es un 20% más fácil de leer.
- Usa Pretty Print por defecto y asegura que gzip esté soportado.
- No uses respuestas encapsuladas por defecto.
- Considera usar JSON para cuerpos de peticiones POST, PUT y PATCH.
- Provee encabezados de respuesta útiles para controles de tráfico (rate limiting).
- Usa autenticación basada en tokens.
- Incluir encabezados de respuesta que faciliten el caché.
- Define un error de carga útil (payload) que sea consumible
- Utilizar efectivamente los códigos de error HTTP