뉴스피드를 제작하는 팀프로젝트를 진행하게되어서 주제를 정하고 진행하던중
API 명세서를 제작해서 제출해야하는데
기존에 API 명세서는 GET
,POST
이러한 방식이였으나
이번 프로젝트는 서버와 함께 개발하는것이 아니라 프론트엔드 개발만 진행하게되어서
Firebase
를 통해 서버쪽 구현을 하게되었다.
Firebase API 문서
https://firebase.google.com/docs/firestore/manage-data/add-data?hl=ko&authuser=0
해당 문서를 참조하여 API 문서를 작성해야하는데 예시로는
기능 | FB Service | api 함수 | Key Arguments | Response | 비고 |
---|---|---|---|---|---|
회원가입 | Authentication | createUserWithEmailAndPassword | email, password | ||
팬레터 추가 | Firestore | addDoc | { nickname: "닉네임", content: "내용"} | ||
팬레터리스트 조회 | Firestore | getDocs | [ { “속성1”: 데이터1}, … ] | ||
프로필 수정 | Authentication | updateProfile | (수정할 속성만 선택적으로 기입){ displayName: “변경할 닉네임”, photoURL: “변경할 프로필이미지”} | ||
이미지 업로드 | Storage | uploadBytes | File 객체 |
이런 표를 그릴수있으며
Firebase
는 NoSQL 이므로 따로 테이블을 명시할수는 없지만
Collection
을 설계하여 테이블처럼 사용이 가능하다.