[TIL - 230329] "API 명세"에 대해 간단하게 정리

TIL/Today I Learned

듬듬 2023. 3. 29. 00:37

1. API 명세는 팀 단위로 개발할 때, 반드시 필요한 부분임.

(개발자가 3명 이상만 되어도.. API 명세를 위한 도구를 사용해야 성공적으로 프로젝트를 완성할 수 있음!)

2. Git과 같은 기본적인 도구임.

3. API 명세가 없는 경우 (과정)
① 서버 개발자가 로그인 API 를 만들어 줌.

② 서버 개발자 -> 클라이언트 개발자에게 로그인 API를 어떻게 사용하면 되는 지 알려줌.

ex) 어떤 URL에 접속해서 어떤 파라미터를 보내면 되는 지를 엑셀 파일 등에 담아서 전달해줌!

③ 엑셀 파일로 알려주는 건 관리가 쉽지 않음. 그래서 API 명세 관련해서 툴을 사용하는 거~!

4. 1개월 ~ 2개월 이상 길게 진행할 프로젝트에서 사용하면 좋음.