[OAS(Open API Spec)를 활용하여 프론트, 백엔드 협업 워크플로우 개선하기] - api 코드가 바뀌면 문서도 바꿔줘야 하는 번거로움 - 백엔드가 어느 정도 구현이 되어야 프론트엔드에

[OAS(Open API Spec)를 활용하여 프론트, 백엔드 협업 워크플로우 개선하기] - api 코드가 바뀌면 문서도 바꿔줘야 하는 번거로움 - 백엔드가 어느 정도 구현이 되어야 프론트엔드에서 api를 붙이기 시작하는 상황 - api가 구현까지 완료된 후에야 프론트엔드의 요구사항이 api spec에 반영되는 상황 - machine-readable한 yaml(or json) 파일 - 자동화된 추가 프로세스가 가능해짐 (api 문서, postman 컬렉션, sdk, mocking 서버 자동 생성) - 단일 진실의 원천: api spec의 내용을 한 곳에서만 관리하며 이를 변경하면 관련된 곳들에 자동으로 반영됨 - 의존성 역전: (프론트 -> 백엔드)의 방향으로 의존하던 방향을 (프론트 -> OAS - openapi spec - openapi generator (for generating sdk) - swagger ui (for documentation) - stoplight (for design) - postman (for test and mocking server) - 백엔드에서 REST API를 디자인하고 구현하는 중에는 프론트에서 UI 개발 정도만 할 수 있음 - API 구현이 어느 정도 완료되면 프론트에서 api를 붙이기 시작함 - REST API 설계를 다같이 진행 - OAS 문법에 맞게 API Spec 작성 - 백엔드, 프론트 동시에 개발 시작