devlog_owen
231121 TIL) 뉴스피드 프로젝트 API 명세서 작성 본문
231121 팀 프로젝트: 뉴스피드 프로젝트
뉴스피드가 뉴스가 있는 피드인가? 아니면 빨리 해야돼서 뉴(NEW)스피드인가 했는데
내 게시물을 포함한 모든 사람들의 게시물을 볼 수 있는 공간 이라고 한다. 블로그,SNS, 커뮤니티 등 다 해당사항들이었다.
우리 팀은 그 중에서 당근마켓같은 지역 커뮤니티 중고물품거래사이트를 만들기로 했다.
글을 쓰니 되게 거창해보이는데 API 명세서를 다 만든 지금 보니까 거창할만 하다.
팀원 담당 정하기
첫날 우선 나는 API 명세서 작성을 맡았고 영진님과 한빛님이 ERD 테이블 만드는걸 맡았다. 선아님은 총괄관리담당이다. 원래 튜터님이 잘 작성해두신 API를 참고했는데 새로 생긴 것들이 엄청 많았다. 댓글 CRUD는 상품 CRUD와 비슷하다고 쳐도 태그, 메시지, 특히 좋아요는 처음 구현해보는 것들이었다.
API 명세서 작성
공오마켓 API 명세서
API 명세서 템플릿 Category,Description,Method,URL,Request Headers,Request Body,Response Headers,Response Body - 성공,Response Body - 실패 인증,회원가입,POST,/api/auth/signup,Content-Type: application/json,# 데이터 타입 { "email": stri
docs.google.com
일단 작성을 완료했는데 아마 분명 수정될 것 같다. 직접 코드 치면서 알게되겠지 뭐...
오늘 처음 알았던 거는 일단 태그같은 경우 삭제를 수정기능 안에 포함시켜서 한다는 거였다. 생각해보면 네이버 블로그 쓸때나 인스타 게시물 올릴때 태그삭제는 못봤던거같고 항상 수정이었던거 같다.
또, 메시지같은 경우 원래는 채팅처럼 보낼때는 처음에는 POST로 생성, 그 다음 메시지는 PUT이라고 들었는데 우리 프로젝트같은 경우는 그냥 메일형식처럼 보내는 걸로해서 POST만 넣었다. 휴~
'TIL' 카테고리의 다른 글
| 231123 TIL) 뉴스피드 프로젝트 3일차 (1) | 2023.11.23 |
|---|---|
| 231122 TIL) 뉴스피드 프로젝트 2일차 (1) | 2023.11.22 |
| 231120 TIL) GIT issue 자동으로 끄기,sequelize,NPM 사이트,prettierrc 코드 (1) | 2023.11.20 |
| 231117 TIL) 알고리즘 2문제, 개인 프로젝트 (0) | 2023.11.17 |
| 231116 TIL) Sequelize, MySQL 연결하기 (0) | 2023.11.16 |
