협업 워크플로

이 가이드에서는 초기 설계부터 배포까지 Apidog에서 API 협업을 수행하기 위한 권장 워크플로를 설명합니다.

워크플로 개요

다음 워크플로는 API 설계자, 개발자, QA 엔지니어 간의 원활한 협업을 보장합니다.

1. API 문서 초안 작성

API 설계자는 Apidog에서 초기 API 문서를 작성하여 엔드포인트, 매개변수, 스키마 및 예상 응답을 정의합니다.

2. 협업 검토

프런트엔드 및 백엔드 개발자는 함께 문서를 검토하고 개선하여 다음 사항에 대한 정합성을 보장합니다.

API 사용 사례 및 요구 사항

요청/응답 구조

데이터 모델 및 스키마

오류 처리

3. 목 데이터를 활용한 개발 착수

프런트엔드 개발자는 Apidog의 API 문서를 기반으로 자동 생성된 목 데이터를 사용하여 즉시 개발을 시작할 수 있습니다.

이점:

수동 목 규칙 생성이 필요하지 않습니다.

백엔드 완료를 기다리지 않고 병렬 개발이 가능합니다.

테스트를 위한 현실적인 데이터 구조를 제공합니다.

4. API 사용 사례를 활용한 디버깅

백엔드 개발자는 개발 중에 사전 정의된 사용 사례를 사용하여 API를 디버깅합니다.

완료 기준:

모든 사용 사례가 성공적으로 디버깅을 통과합니다.

개발 중 발생한 모든 변경 사항이 API 명세에 자동으로 업데이트됩니다.

시기적절하고 비용 효율적인 API 유지 관리를 보장합니다.

5. 엔드포인트 케이스 저장

디버깅이 완료되면 백엔드 개발자는 성공한 요청을 다음 목적의 엔드포인트 케이스로 저장합니다.

향후 테스트

정상 동작 예시 문서화

QA 참고 자료

6. API 테스트

QA 엔지니어는 사전 정의된 엔드포인트 케이스를 사용하여 API를 직접 테스트하고, 다음 사항을 보장합니다.

기능적 정확성

예상 응답 형식

오류 처리

엣지 케이스

7. 통합 테스트

모든 API가 개발된 후 QA 엔지니어(또는 백엔드 개발자)는 테스트 컬렉션 기능을 활용하여 포괄적인 다중 API 통합 테스트를 수행합니다.

목적:

API 호출 프로세스가 원활하게 작동하는지 확인합니다.

엔드투엔드 워크플로를 테스트합니다.

엔드포인트 간 데이터 흐름을 검증합니다.

8. 공동 디버깅

프런트엔드 및 백엔드 개발이 모두 완료되면 다음을 수행합니다.

프런트엔드 개발자가 목 데이터에서 실제 데이터로 전환합니다.

양 팀이 통합이 예상대로 작동하는지 확인합니다.

호환성을 보장하기 위해 API 명세를 세심하게 준수합니다.

이 워크플로의 이점

이점	설명
병렬 개발	프런트엔드 및 백엔드 팀이 동시에 작업합니다.
오류 감소	명세 기반 개발을 통해 의사소통 오류를 최소화합니다.
더 빠른 반복	자동 목 데이터 및 명세 업데이트를 통해 개발 속도를 높입니다.
더 나은 테스트	사전 정의된 케이스 및 통합 테스트로 품질을 보장합니다.
명확한 문서화	살아 있는 문서가 구현과 동기화된 상태로 유지됩니다.

워크플로 개요#

1. API 문서 초안 작성#

2. 협업 검토#

3. 목 데이터를 활용한 개발 착수#

4. API 사용 사례를 활용한 디버깅#

5. 엔드포인트 케이스 저장#

6. API 테스트#

7. 통합 테스트#

8. 공동 디버깅#

이 워크플로의 이점#