HomeAboutMeBlogGuest
© 2025 Sejin Cha. All rights reserved.
Built with Next.js, deployed on Vercel
🍗
[New] 조규현팀
/
인스타뀨램
인스타뀨램
/
🎰
API 설계
🎰

API 설계

✋
규칙📏Response Convention🐶 성공 예시👾 실패 예시 (예외처리 응답)
 

규칙

  • 에픽 태그를 둬서 그룹으로 나눠서 볼 수 있게 합니다.
  • API의 상태를 상태 태그를 통해서 확인할 수 있게 합니다.
  • 인라인 테이블 만들어서 그룹으로 관리해요 🙂
  • 북마크, 캡쳐, 코드 남겨주세요.
 

확장 익스텐션

  • mermaid.js
    • Online FlowChart & Diagrams Editor - Mermaid Live Editor
      Simplify documentation and avoid heavy tools. Open source Visio Alternative. Commonly used for explaining your code! Mermaid is a simple markdown-like script language for generating charts from text via javascript.
      Online FlowChart & Diagrams Editor - Mermaid Live Editor
      https://mermaid.live/edit
댓글 작성 API 예제

 
게시글
url
Method
Group
진행상태
MoSCoW
⛰️
게시글을 작성하는 API
POST
게시글
진행중
Must have
🎨
게시글 간편조회 하는 API
GET
게시글
진행중
Must have
⚗️
팔로우한 게시글을 조회하는 API
GET
게시글
진행중
Must have
🌒
상세 게시글을 조회하는 API
GET
게시글
진행중
Must have
🗂️
게시글을 수정하는 API
PUT
게시글
진행중
Must have
🪣
게시글을 삭제하는 API
DELETE
게시글
진행중
Must have
🎻
게시글을 좋아요하는 API
POST
게시글
진행중
Must have
🏆
게시글 좋아요를 취소하는 API
DELETE
게시글
진행중
Must have
🪆
해시태그를 등록하는 API
POST
게시글
진행중
Should have
🏰
자신의 게시글을 조회하는 API(X)
GET
게시글
진행중
Must have
댓글
url
Method
Group
진행상태
MoSCoW
🪧
댓글을 작성하는 API
POST
댓글
진행중
Must have
⌛
댓글을 조회하는 API
GET
댓글
진행중
Must have
🎓
댓글을 삭제하는 API
DELETE
댓글
진행중
Must have
🪐
댓글을 좋아요하는 API
POST
댓글
진행중
Must have
🎍
댓글 좋아요를 취소하는 API
DELETE
댓글
진행중
Must have
회원
url
Method
Group
진행상태
MoSCoW
🫂
팔로우 API
POST
회원
시작전
Must have
🙅🏻‍♂️
언팔로우 API
POST
회원
시작전
Must have
❄️
프로필 수정
PATCH
회원
시작전
Should have
🛻
프로필 조회
GET
회원
시작전
Must have
🌖
로그아웃 API
POST
회원
시작전
Must have
💼
로그인 API
POST
회원
시작전
Must have
🛍️
회원가입 API
POST
회원
시작전
Must have
🪙
팔로우 Count [post 상세조회]
GET
회원
시작전
Must have
🎲
팔로워 Count [post 상세조회]
GET
회원
시작전
Must have
 
 

📏Response Convention


🐶 성공 예시

// 단일건 { "response": { "id": 3000001, "barcode": "49319927-68ed-4bc3-b022-6c099195f48c", "itemId": 10, "qty": 1 }, } // 다중건 { "response": [ { "id": 3000000, "barcode": "12cbf5bf-2c96-4172-acb6-4c24a853d255", "itemId": 6, "qty": 1 }, { "id": 3000001, "barcode": "49319927-68ed-4bc3-b022-6c099195f48c", "itemId": 10, "qty": 1 } // ... ], }

👾 실패 예시 (예외처리 응답)

{ "timestamp": "2022-06-15T16:28:39.390154", "message": "Could not found Product with barcode=49319927-68ed-4bc3-b022-6c099195f48" } { "code" : V0001 "message" : } // 병연 { timestamp : "사용자이름을 잘못 입력했습니다" .. }
코드
내용
v0012
아이디값 오류
v1231
비밀번호 오류
 
🔄
팀 프로젝트