한국어

백엔드 API 리뷰와 인계

API 응답 계약, 재시도, 페이지네이션, 마이그레이션 순서를 합의할 때 쓰는 한국어 문구입니다. 코드 리뷰나 프론트엔드 인계 대화에 붙여 쓸 수 있습니다. 보내기 전에 대괄호 안의 내용을 실제 정보로 바꾸세요.

도윤

0likes10snippets

Try it here

Snippet

Loading snippet…

Your typing stays in this tab. Nothing is saved or sent.

Snippets (10)

;kbe-cursor

페이지네이션 동률 정렬

정렬값이 같은 항목이 여러 개일 때 순서가 고정되도록 고유 ID 같은 보조 기준이 필요해 보입니다. 커서에도 같은 기준을 반영하고 페이지 경계에서 중복·누락을 확인해 주세요.

;kbe-errors

오류 코드와 화면 대응

이 오류는 재시도해도 되나요, 입력을 고쳐야 하나요? 클라이언트가 구분할 오류 코드도 부탁드립니다.

;kbe-null

null과 필드 생략 구분

값이 없으면 null인가요, 필드 생략인가요? 데이터가 있는 응답과 없는 응답 예시를 함께 부탁드립니다.

;kbe-retry

재시도 시 중복 처리

응답을 받지 못한 클라이언트가 같은 요청을 다시 보내도 결과가 중복 생성되지 않아야 합니다. 같은 요청을 식별하는 키와 중복 요청에 돌려줄 응답을 함께 정해 주세요.

;kbe-zone

일시 값과 날짜 값 구분

이 값이 특정 시각인지, 시간대와 무관한 날짜인지 먼저 구분하면 좋겠습니다. 시각이라면 시간대 정보와 변환 주체를 명시해 주세요. 날짜만 있는 값은 화면에서 하루 밀리지 않는지도

;kbe-schema

스키마 변경 배포 순서

구버전 코드가 남아 있는 동안에도 이 스키마 변경이 안전한지 확인이 필요합니다. 컬럼 추가, 데이터 이관, 코드 전환, 기존 컬럼 제거 순서를 나눠서 배포 계획을 적어 주세요.

;kbe-budget

외부 호출 대기 시간

외부 호출을 재시도하면 전체 요청 시간이 얼마나 길어지는지 보고 싶습니다. 연결·응답 대기 시간과 재시도 간격을 합쳐 상위 요청의 제한 시간 안에 끝나는지 확인해 주세요.

;kbe-atomic

DB와 외부 처리 실패 순서

DB 저장은 성공했는데 외부 호출만 실패하면 어떤 상태로 남나요? 반대 순서의 실패도 포함해 재처리 대상을 어디에 기록하고 누가 다시 실행하는지 정리해 주세요.

;kbe-hook

웹훅 중복과 순서 역전

같은 이벤트를 두 번 받는 경우와 예전 이벤트가 늦게 오는 경우를 나눠 테스트해 주세요. 중복 처리를 막는 것과 최신 상태가 과거 상태로 돌아가지 않게 하는 것은 각각 확인이 필요

;kbe-trace

요청 로그 확인 의뢰

실패한 요청의 ID는 [요청 ID]이고 발생 시각은 [시각·시간대]입니다. 이 요청이 어느 단계에서 끝났는지 로그로 확인 부탁드립니다. 재시도해도 되는 상태인지도 알려 주세요.