API 요청과 응답 형식은 어떻게 정하나요?
필드의 의미와 필수 여부, 오류 응답을 명확히 정하세요. 성공 응답만 문서화하지 말고 권한과 입력 실패도 함께 다루는 편이 좋습니다.
적용 범위
저장 기능은 성공 여부와 중복 실행, 실패 복구까지 포함해 설계해야 합니다. 외부 서비스 호출에는 입력 검증과 제한된 권한을 적용하는 것이 좋습니다.
확인할 항목
- 저장 완료와 화면 표시 구분
- 동일 요청 반복 상황 시험
- 외부 실패와 시간 초과 처리
공식 참고 자료
아래 자료는 이 주제의 개념과 검토 기준을 확인하는 공식 참고 문서입니다. 작업 순서와 비교 방법은 편집팀의 제안이며, 제품의 성능을 직접 시험했다는 뜻은 아닙니다.
- MDN HTTP 상태 코드확인일 2026-10-20
- NIST AI 위험관리 프레임워크확인일 2026-10-20
- OWASP 생성형 AI 보안 위험확인일 2026-10-20
관련 질문
외부 요청에 시간 제한이 필요한가요?
응답이 오지 않는 작업이 계속 자원을 점유하지 않게 제한하는 것이 좋습니다. 시간 초과 후 재시도할지 사용자가 확인할지 동작도 정하세요.
외부 요청에 시간 제한이 필요한가요 자세히 보기 ↗외부 요청을 바로 반복해도 되나요?
실패 종류를 구분하고 간격을 두는 재시도 정책을 적용하는 편이 좋습니다. 인증 실패처럼 반복해도 해결되지 않는 오류는 설정 확인으로 넘겨야 합니다.
외부 요청을 바로 반복해도 되나요 자세히 보기 ↗요청 제한은 어디에 적용하나요?
사용자와 외부 서비스의 제한을 각각 고려하세요. 서버 인스턴스가 여러 개면 한 프로세스의 메모리 제한만으로 전체 요청을 제어할 수 있는지 확인해야 합니다.
요청 제한은 어디에 적용하나요 자세히 보기 ↗