API 설계

API를 설계는 주로 URL, HTTP메소드, 각 API들이 어떤 기능을 하게될지 등을 미리 정해서 문서화 하는것을 말한다. 해당 문서를 토대로 개발을 진행하는 것이다.

API 설계하기

보통 구글 스프레트 시트나, 엑셀파일로 API를 설계한다.
나는 (종류, URL, Method, 기능, 설명) 이렇게 컬럼을 나누어 API 문서화를 할 것이다.

개인 구글 스프레드 시트에 작성한 API 설계서 링크

• 스프레드 시트에 엔드포인트를 문서화
  
• 스프레드 시트에 API 스펙을 문서화
  

• API 설계서 Issue comment 등록(링크도 업로드)