/>API 설계
엔드포인트, 상태 코드, 페이지네이션, 멱등성이 계약을 어떻게 만드는지 보여줍니다. — 26개 항목
토큰 버킷 속도 제한Token bucket rate limiting
일정 속도로 채워지는 토큰을 요청마다 소모해 API의 평균 요청률과 순간 버스트를 제어합니다.
REST 자원 모델REST Resource Model
URI로 자원을 가리키고 HTTP 메서드로 조회·생성·수정을 표현합니다.
커서 페이지네이션Cursor Pagination
마지막으로 읽은 항목의 위치를 커서로 넘겨 새 항목이 추가돼도 이어서 읽습니다.
오프셋 페이지네이션Offset Pagination
offset과 limit으로 위치를 지정하지만 앞쪽 삽입이 페이지 경계를 밀 수 있습니다.
멱등성 키Idempotency Key
재시도 요청에 같은 키를 붙여 한 번 처리한 생성 작업이 중복 실행되지 않게 합니다.
API 오류 응답 형식API Error Envelope
여러 오류를 일정한 code·message·details 구조로 돌려줘 클라이언트 처리를 단순하게 합니다.
API 계약API Contract
경로·요청·응답·오류 규칙을 클라이언트와 서버가 함께 지키는 약속으로 정의합니다.
스키마 검증Schema Validation
입력 데이터의 타입·필수 필드·값 범위를 계약과 대조해 잘못된 요청을 경계에서 막습니다.
GraphQL 질의GraphQL Query
클라이언트가 필요한 필드를 질의에 적으면 그 선택 형태로 응답이 돌아옵니다.
GraphQL N+1 문제GraphQL N+1 Problem
목록의 각 행에서 연관 데이터를 따로 읽으면 DB 호출 수가 행 수만큼 늘어납니다.
gRPC 스트리밍gRPC Streaming
한 RPC 안에서 메시지를 여러 번 보내거나 받아 긴 데이터 흐름을 구성합니다.
웹훅 전달Webhook Delivery
이벤트가 생기면 제공자가 수신자 URL로 요청을 보내고 실패하면 재시도합니다.
API 게이트웨이API Gateway
한 진입점에서 인증·요청 제한·서비스 라우팅을 적용합니다.
OpenAPI 3.2
HTTP QUERY·추가 연산·스트리밍 표현 같은 API 계약을 명세에 적을 수 있습니다.
OpenAPI 스트리밍 미디어 표현OpenAPI Streaming Media Types
OpenAPI 3.2에서 JSON Lines와 SSE처럼 항목이 순차 도착하는 응답을 기술합니다.
Arazzo API 워크플로Arazzo API Workflows
여러 API 호출을 단계와 입출력 연결로 묶어 하나의 사용자 흐름으로 기술합니다.
OpenAPI 오버레이OpenAPI Overlays
원본 API 설명을 직접 수정하지 않고 별도 작업 목록을 적용해 문서를 보강합니다.
GraphQL OneOf 입력GraphQL OneOf Input
@oneOf 입력 객체는 여러 선택지 중 정확히 하나의 null이 아닌 값만 받습니다.
OpenAPI 추가 HTTP 연산OpenAPI Additional Operations
OpenAPI 3.2의 additionalOperations로 기본 필드 밖의 HTTP 메서드를 문서화합니다.
API 하위 호환성API Backward Compatibility
새 서버 계약이 기존 클라이언트의 요청·응답 기대를 계속 만족하는지 살핍니다.
OpenAPI 중첩 태그OpenAPI Nested Tags
OpenAPI 3.2의 parent와 kind로 연산 태그를 계층형 문서 탐색에 배치합니다.
GraphQL over HTTP 초안GraphQL over HTTP Draft
GraphQL 요청의 HTTP 메서드와 응답 미디어 타입을 상호운용 가능한 규칙으로 정의합니다.
Arazzo의 AsyncAPI 단계AsyncAPI Steps in Arazzo
Arazzo 1.1에서 메시지 전송과 수신을 워크플로 단계로 연결하고 응답을 상관 ID로 기다립니다.
OpenAPI 기기 인가 흐름OpenAPI Device Authorization Flow
OpenAPI 3.2는 입력이 불편한 기기의 OAuth 인가 흐름과 필요한 URL을 명세에 표현합니다.
API 버저닝API Versioning
기존 소비자를 유지하면서 바뀐 계약을 새 버전으로 제공하는 전환 전략입니다.
콘텐츠 협상Content Negotiation
Accept 헤더로 원하는 표현 형식을 알리고 서버가 지원하는 응답 타입을 선택합니다.