jay.log

업무 프로세스 개선 및 API 문서화

애기야가자 • 2022.07 - 2024.10

백엔드 개발자와 협업할 때 생기던 명세 불일치 문제를 해결하기 위한 협업 프로세스 개선이었습니다. 기능 단위 PR과 OAS(YAML) 기반 사전 합의 후 메인 브랜치에 병합하는 프로세스를 정착시켰고, GitHub Actions·Orval 파이프라인으로 요청 함수와 타입을 자동 생성했습니다.

도전 과제

  • API 명세와 실제 구현의 불일치
  • 반복적인 타입 정의 작업

해결 방안

  • OAS(YAML) 기반 사전 합의 후 병합
  • Orval로 요청 함수·타입 자동 생성

결과

  • 명세 불일치로 인한 재작업 제거
  • 요청 함수·타입 수동 작성 제거

기술 스택

OpenAPIOrvalGitHub ActionsTypeScript

© jay.log powered by Next.js, Vercel