¿Cuáles son?
-
Crea URI de Recurso (REST API) que sean fáciles de entender e identificar. Deberían claramente indicar cuál es el recurso y que representa
-
Utiliza correctamente los Métodos HTTP para realizar la acción apropiada sobre un Recurso (REST API). Utiliza GET para leer datos, POST para crear datos, PUT o PATCH para actualizar datos y DELETE para eliminar datos.
-
Utiliza correctamente los códigos de respuesta HTTP para indicar el resultado de la operación. Utiliza 200 para operaciones correctas, 201 para recursos recién creados, 204 para eliminaciones correctas, 400 para solicitudes incorrectas y 404 para errores de no encontrado.
-
Utiliza sustantivos en lugar de verbos en las URIs para representar a los Recurso (REST API) con el fin de hacerlo más intuitivo y fácil de usar.
-
Se consistente en las convenciones de naming para los endpoints de los Recurso (REST API), los Métodos HTTP y las estructuras request/response con el fin de mejorar su entendimiento y mantenimiento.
-
Genera un documentación compresible con los detalles sobre los endpoints, los parámetros y las respuestas esperadas
-
Versiona la API para asegurar que los cambios no romperán las funcionalidades existentes. Esto puede realizarse añadiendo un numero de versión delante de la URI y posterior al dominio: `https://api.example.com/v1/books
-
Aplica las medidas de seguridad como son la autenticación, autorización y encriptación.
-
Ten presente el rendimiento por medio de observar los tiempos de respuesta, el caching y la optimización de queries a bases de datos. También hay estrategias de paginación para reducir la cantidad de información en las responses
-
Gestiona los errores y definelos por medio de Códigos HTTP y mensajes clarificadores