업무자동화반
개발 입문자를 위한 API 요청 설계
간단한 REST 호출을 가정하고, 헤더·바디·에러 응답을 문장으로 명세하는 연습입니다.
설명
코드를 작성하기보다 요청서를 작성하는 데 집중합니다. '업무자동화 스크립트 설계반'의 스키마 개념을 기술 문맥으로 옮겨 적습니다.
포함 기능
- 요청서 템플릿(목적·엔드포인트·필드)
- 에러 코드별 대응 문장
- 재시도 정책 서술
- 로그에 남길 필드 최소집합
- 보안 메모(토큰 저장 금지 등)
- 페어 리뷰 체크리스트
기대 결과
- 백엔드 동료가 읽기 쉬운 요청서 초안을 작성합니다.
- 에러 응답을 사용자 언어로 번역하는 습관을 갖춥니다.
- 테스트 시나리오 3건을 문장으로 정의합니다.
FAQ
실제 API 키가 필요한가요?
과제는 모의 엔드포인트로 진행합니다.
언어는?
문서와 설명은 한국어, 필드명은 영어 예시를 사용합니다.
포함되지 않는 것은?
서버 구축, 인프라 비용, 외부 클라우드 계정은 포함되지 않습니다.
후기
요청서 템플릿이 신규 입사자 온보딩 문서에 그대로 들어갔습니다.