API 요구사항 템플릿이란?
개발 시작 전에 제품, 엔지니어링, 아키텍처 팀이 API 요구를 정의하도록 돕는 협업형 API 기획 템플릿입니다. 워크숍은 다음 다섯 단계로 진행됩니다: API 정보 수집, 아키텍처 영향 분석, 사용자 스토리 작성, 기술 요구사항 및 의존성 문서화, 그리고 구현 로드맵 작성.
API 요구사항 템플릿은 어떤 문제를 해결하나요?
불완전한 API 요구사항
통합 필요사항이 불명확함
아키텍처 맥락 누락
사용자 요구와 기술적 요구 불일치
숨겨진 종속성
제품과 엔지니어링 간 정렬 부족
구현 순서 불명확
API 요구사항 템플릿 사용 방법
먼저 API 정보, 이해관계자, 시스템, 비즈니스 요구사항을 수집합니다.
아키텍처 영향을 검토하고 시스템, 서비스, 통합의 연결 방식을 맵으로 작성합니다.
사용자, 시스템 또는 내부 팀이 API에 필요로 하는 내용을 설명하는 사용자 스토리를 작성합니다.
기술 요구사항, 종속성, 보안 필요사항, 데이터 고려사항 및 통합 제약을 문서화합니다.
우선순위, 마일스톤, 구현 순서를 반영해 요구사항을 로드맵으로 정리합니다.
자주 발생하는 실수
API 목적이 명확해지기 전에 개발을 시작함
사용자 요구를 이해하지 않고 엔드포인트를 문서화함
아키텍처 영향 분석을 생략함
시스템 간 종속성 무시
보안 또는 데이터 요구사항 누락
너무 기술적인 사용자 스토리 작성
명확한 우선순위 없이 로드맵 작성
실수 방지 방법
구현 논의 전에 API 목적을 정의하세요.
제품, 엔지니어링, 아키텍처, 보안 관점을 포함하세요.
사용자 스토리를 기술적 요구사항과 연결하세요.
작업 우선순위를 정하기 전에 의존관계를 매핑하세요.
가정과 미해결 질문을 문서화하세요.
보안, 인증, 데이터, 성능 요구사항을 초기에 검토하세요.
의존관계와 비즈니스 가치에 따라 로드맵 항목의 순서를 정하세요.
사용 가능한 Miro 기능
각 워크숍 단계별 프레임
요구사항과 미해결 질문을 위한 스티커 메모
시스템 관계를 위한 아키텍처 다이어그램
사용자 스토리와 기술 요구사항을 위한 표
우선순위, 의존성 및 오너십을 위한 태그
엔지니어링 논의를 위한 댓글
요구사항 카테고리별 색상 구분
아키텍처 흐름을 위한 커넥터
마일스톤 및 릴리스용 로드맵 도형
자주 묻는 질문
Q: 이 템플릿은 누가 사용하면 좋나요?A: 제품 관리자, 소프트웨어 엔지니어, 아키텍트, API 개발자, 보안팀, 통합팀, 기술 리드 및 교차 기능 제품 팀.
Q: 언제 이 템플릿을 사용해야 하나요?A: 새로운 API를 구축하기 전, 기존 API를 확장할 때, 통합을 계획할 때 또는 API 아키텍처를 검토할 때 사용하세요.
Q: 이 템플릿에 사용자 스토리가 포함되어 있나요?A: 예. 한 단계는 API 요구를 사용자 스토리로 전환해 기술 요구사항을 확정하기 전에 사용합니다.
Q: 어떤 유형의 기술 요구사항을 기록할 수 있나요?A: 인증, 인가, 엔드포인트, 데이터 형식, 통합, 종속성, 성능, 오류 처리, 모니터링 및 관련 기술 요구사항을 기록할 수 있습니다.
Q: 이 템플릿은 내부 및 외부 API를 지원하나요?A: 네. 내부 서비스, 파트너 통합, 공개 API, 플랫폼 API에 사용할 수 있습니다.
Q: 참가자들은 무엇을 얻어가나요?A: 문서화된 API 목적, 아키텍처 영향도 보기, 사용자 스토리, 기술 요구사항, 종속성, 우선순위가 지정된 구현 로드맵.
