인터페이스 문서 작성

프론트엔드와 백엔드 협업

인터페이스를 정의해두고 골조만 합친 후 동시에 개발하면 빠르고 안전하게 병행 개발이 가능하다.

이때 중요한 것이 인터페이스 정의이다. 필요한 api가 무엇인지, api의 end-point는 무엇인지, req/res의 정보와 구조는 어떻게 되는지를 정의해두고 문서화하면 개발 분야별 선후관계없이 병행 개발이 가능하다. 인터페이스 문서가 있으므로 변경이나 추가도 용이하다. 상호 개발 시 오해와 오역으로 인한 비용 증가를 없앨 수 있다.

인터페이스가 완성됐다면 개발 시점에 단위 테스트를 두고 지속적으로 약속대로 개발되고 있는지 확인하는 것이 좋다. 테스트가 실패하는 api가 있다면 곧바로 인터페이스 문서를 확인하고 변경에 관해 공유되었는지를 파악해야 한다.