EST-DGT-003 Estructura de Endpoints

v 1.0

Propósito

Este estándar tiene como propósito mostrar a los desarrolladores de LinkBridge la estructura designada para la creación de endpoints en el proyecto.

Notas introductorias

Los endpoints en una API son como puertas de entrada que permiten a las aplicaciones enviar y recibir datos de manera segura y organizada.

Estándares

Estructura de Endpoints

BASE_URL/api/v{version}/{entidad}/{atributo}

• BASE_URL: URL base de la API.
• version: Versión de la API.
• entidad: Nombre de la entidad a la que se quiere acceder, crear, modificar o eliminar.
• atributo: Atributo de la entidad

CRUD

1. Create Para crear una entidad se hace un POST al endpoint respectivo con el body conteniendo los datos requeridos.

2. Read Para consultar una entidad específica se consulta al endpoint de la entidad con GET con su ID. Para consultar toda una lista se hace un GET al endpoint sin un ID específico.

3. Update Para modificar una entidad se hace un PUT al endpoint respectivo, especificando el ID de la entidad a modificar.

4. Delete Para eliminar una entidad se hace un DELETE al endpoint respectivo, especificando el ID de la entidad a eliminar.

Control de cambios

Versión	Cambio realizado	Análisis	Autor	Revisor(es)	Fecha de cambio
v 1.0	Migración a estándar	N/A	Arturo Díaz	Ian Padrón	30/04/2024