[Play Data] Final Project - Django API Speicification

이정연·2023년 6월 7일
0

Play Data

목록 보기
25/26

장고 아키텍처

대략적인 시스템 아키텍처를 구상 후 효율적인 업무 분담을 위해 각 기능들을 구체화할 필요가 생겼다.

API 명세서를 미리 작성해 장고 프로젝트의 구조에 대하여 명확히 파악하려고 한다.

API 명세서

1️⃣ 회원 API

HTTPPathMethodPermission목적
POST/api/user/signupCREATEAllowAny사용자 회원가입
POST/api/user/signinNONEAllowAny사용자 로그인, access_token 생성 및 반환
API/api/user/login/kakao/NONEAllowAny카카오 소셜 로그인, access_token 생성 및 반환
API/api/user/login/naver/NONEAllowAny네이버 소셜 로그인, access_token 생성 및 반환

2️⃣ 싱잉 리스트 API

HTTPPathMethodPermission목적
GET/api/songs/LISTAllowAny모든 곡 목록 확인
GET, PUT, DELETE/api/songs/<int:pk>/RETRIEVE, DESTORYAccess_token or ReadOnly OR IsOwner곡 하나 확인, 삭제
POST/api/songs/add/CREATEAccess_token곡 추가

3️⃣ 게시판 API

HTTPPathMethodPermission목적
GET/api/posts/LISTAllowAny모든 게시글 목록 확인
GET, PUT, DELETE/api/posts/<int:pk>/RETRIEVE, UPDATE, DESTORYAccess_token or ReadOnly OR IsOwner게시글 하나 확인, 수정, 삭제
POST/api/posts/create/CREATEAccess_token게시글 생성
POST/api/posts/<int:pk>/comments/createCREATEAccess_token해당 게시글에 댓글 생성
GET, PUT, DELETE/api/posts/<int:pk>/comments/RETRIEVE, UPDATE, DESTORYAccess_token댓글 확인, 수정, 삭제
GET/api/posts/search/category/LISTAllowAny카테고리별 검색
profile
0x68656C6C6F21

0개의 댓글