API & Endpoint
API y Endpoint
Un API es un conjunto de reglas para que dos programas hablen. Un endpoint es una sola dirección y una sola operación dentro de ese API.
Otro ejemplo
La aplicación llama a GET /api/projects. Obtiene los datos del proyecto en la forma de respuesta de la documentación de la API.
Partes principales
- 01Originating request
- 02Resolution or processing hop
- 03Response, timing, and failure
Úsalo cuando
El contrato de la API debe indicar claramente sus métodos, esquemas, errores, permisos y versiones.
No lo uses cuando
Nunca expongas la estructura privada de la base de datos o detalles de implementación que puedan cambiar.
Nombre usado en código
HTTP method + route + schema Antes de lanzarlo
Check contracts and invariants, authorization, and input limits. Test retries, one-time effects, timeouts, and partial failures. Verify data integrity, compatibility, monitoring, recovery, and rollback.
Outcome: Complete the task with API y Endpoint (API & Endpoint). User context: La aplicación llama a GET /api/projects. Obtiene los datos del proyecto en la forma de respuesta de la documentación de la API. Technical concept or control: API y Endpoint (API & Endpoint). Why it fits: El contrato de la API debe indicar claramente sus métodos, esquemas, errores, permisos y versiones. Do not use it when: Nunca expongas la estructura privada de la base de datos o detalles de implementación que puedan cambiar. Engineering requirements: Define inputs, outputs, contracts, and rules that must always hold. Set authorization and input checks. Define failures, timeouts, retries, one-time effects, data moves, and compatibility limits. Operations: Add useful signals and logs that hide sensitive data. Set capacity limits and write an operator guide. Test recovery and rollback. Acceptance criteria: Contract and failure-path tests pass. Data and authorization rules still hold during retries and partial failures. Check performance limits, monitoring, recovery, and rollback. Evidence and limits (evidence boundary): Ningún estándar oficial único controla todo el término. Su significado puede cambiar según equipos, plataformas o marcos. Unknowns to confirm: Where the code runs, data stores, traffic shape, consistency needs, and the security boundary. Also confirm the compatibility period, service goals, and rollback limits.
Revisa esta petición
Review how API y Endpoint (API & Endpoint) is used now. Definition: Un API es un conjunto de reglas para que dos programas hablen. Un endpoint es una sola dirección y una sola operación dentro de ese API. Release checks: Check contracts and invariants, authorization, and input limits. Test retries, one-time effects, timeouts, and partial failures. Verify data integrity, compatibility, monitoring, recovery, and rollback. Before changing code, list the evidence, gaps, severity, and the smallest safe fix.