API & Endpoint
API & 엔드포인트
API는 소프트웨어끼리 대화하는 규칙의 모음이에요. 엔드포인트는 그 API에 있는 하나의 주소이자 하나의 동작이죠.
다른 예시
앱은 GET /api/projects를 호출합니다. API 문서에 있는 응답 형태로 프로젝트 데이터를 받습니다.
주요 부분
- 01Originating request
- 02Resolution or processing hop
- 03Response, timing, and failure
사용할 때
API 계약은 그 메서드, 스키마, 오류, 권한, 버전을 명확하게 명시해야 합니다.
다음 경우에는 사용하지 마세요
바뀔 수 있는 데이터베이스의 구조나 구현 세부 사항을 노출하지 마세요.
코드에서 사용된 이름
HTTP method + route + schema 출시하기 전에
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 & 엔드포인트 (API & Endpoint)。 User context:앱은 GET /api/projects를 호출합니다. API 문서에 있는 응답 형태로 프로젝트 데이터를 받습니다. Technical concept or control:API & 엔드포인트 (API & Endpoint)。 Why it fits:API 계약은 그 메서드, 스키마, 오류, 권한, 버전을 명확하게 명시해야 합니다. Do not use it when:바뀔 수 있는 데이터베이스의 구조나 구현 세부 사항을 노출하지 마세요. 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):하나의 공식 표준이 전체 용어를 통제하지 않음. 의미는 팀, 플랫폼 또는 프레임워크마다 달라질 수 있음. 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.
이 요청을 확인하세요
Review how API & 엔드포인트 (API & Endpoint) is used now. Definition: API는 소프트웨어끼리 대화하는 규칙의 모음이에요. 엔드포인트는 그 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.