이전 세미 프로젝트를 진행한 것과 같이 팀을 구성하고 난 후 첫 만남을 가졌다.
내가 들어간 팀은 이전 이론기간동안 스터디를 진행하는 팀끼리 파이널 프로젝트에 대해 이야기가 진행된 팀이었다.
.
1. 주제 선정 및 진행 상황 공유
아직 개발 전이었고 기획 멘토링 이전에 미팅을 가져 진행상황을 공유받았다.
이전에 정해진 주제가 존재했고 나도 그 주제가 마음에 들어서 이어나가도록 결정됐다.
주제는 소규모 SNS였고 API 명세서는 어느정도 나와있고, ERD도 작성되어있었다.
기획발표 이전에는 남은 API 명세서를 작성하기로 했고, git 구조는 멀티 구조로 결정되었다.
2. API 명세서
API 명세서를 짤 때는 이 주제에서 어떤 것들이 필요한지 이야기를 하고 거기서 어떤 정보를 넘겨야하는지에 대해 프론트 팀원분들과 같이 이야기하며 진행됐다.
카카오 API를 무조건 사용하는 조건이 있었고 우리 팀은 로그인 API를 사용하기로했다.
로그인을 할 때 어떤 정보를 가져올건지 이야기하고(프로필, 생년월일 등)
에러번호에 따른 에러코드도 미리 짜뒀다.
이렇게 기획 단계에서 탄탄하게 해두니 개발할 때 매우 편리했다.
✨내가 정립한 API 작성 가이드라인
- 엔드포인트 / 메서드 : URI 구조와 HTTP Method 정의(GET/POST/DELETE)
- Feat : 어떤 화면(서비스)에서 사용하는지 명시
- Request/Response
- 에러코드
- 노트(데이터 조회 위치 / 공개 원칙 / 계산규칙 / 룰 등 이런 규칙들 작성)
- API 응답형식(성공 / 에러)
⭐만약에 공통 응답형식이 있으면 그것은 따로 코드를 짜두고 불러오는 형식이 더 편리함(중복코드 방지)