감정인식 회의록 Mini Minute

Rest API 통신 규칙

필요 시에 추가나 수정 후 표시 부탁드립니다

Rest HTTP Method

HTTP Method	설명
GET	리소스 조회
POST	리소스 생성
PUT	리소스 전체 수정
PATCH	리소스 부분 수정
DELETE	리소스 삭제

HTTP 응답 코드

Code	설명
200	OK
201	Created
202	Accepted
204	No Content
400	Bad Request
401	Unauthorized
403	Forbidden
404	Not Found
500	Internal Server Error

dJango REST API 주소

이용 시 주의 사항

1. 사용자 개별 정보를 건드릴 때에는 항상 토큰을 같이 실어서 보내야함
   
2. Authorization header에 토큰 실어 보낼 때 : 토큰 값 앞에 jwt + 한 칸 공백 + 토큰 값

/api

토큰 발행, 검증, 갱신 관련 주소

Path	Method	request	response	Code	설명
/token	POST	{email, password}	{token}		JWT 토큰 발행
/token/verify	POST	{token}	{token}		JWT 토큰 검증
/token/refresh	POST	{token}	{token}		JWT 토큰 갱신

/rest-auth

로그인, 회원가입, 비밀번호 변경 주소

Path	Method	request	response	Code	설명
/login	POST	{email, password}	{token, user{ pk, username, email, first_name, last_name}}	200 성공 400 실패(아이디 비밀번호 확인)	로그인
/signup	POST	{email, username, password1, password2}	{token, user{ pk, username, email, first_name, last_name}}	201 성공 400 실패 (빈칸 or 비밀번호 값이 서로 다름)	회원가입
/password/change	POST	{new_password1, new_password2}	{}	200 성공 401 실패(토큰 인증 실패)	비밀번호 변경

/users

회원 정보 관련 주소

Path	Method	request	response	Code	설명
/lists	GET	{email, password	{token, user{ pk, username, email, first_name, last_name}}	200 성공 400 실패(관리자 계정 아님) 401 실패(토큰 인증 실패)	회원 목록 전체 조회 (관리자 계정 전용)
/profile	GET	{}	{id, email, user_profile, password, username, user_sign_up_date, user_access_date}	200 성공 401 실패(토큰 인증 실패)	회원 조회
/name/change	PUT	{username}	{id, email, user_profile, password, username, user_sign_up_date, user_access_date}	200 성공 400 실패(이름 중복) 401 실패(토큰 인증 실패)	회원 이름 변경
/email/change	PUT	{email}	{id, email, user_profile, password, username, user_sign_up_date, user_access_date}	200 성공 401 실패(토큰 인증 실패)	회원 이메일 변경
/withdraw	DELETE	{}	{}	204 성공 401 실패(토큰 인증 실패)	회원 탈퇴
/profile/upload	POST	{}	{id, email, user_profile, password, username, user_sign_up_date, user_access_date}	200 성공 401 실패(토큰 인증 실패)	프로필 업로드 및 수정
/profile/<파일이름>	GET	{}	프로필 사진	200 성공 404 실패(존재하지 않는 파일)	프로필 불러오기

/directorys

디렉토리 정보 관련 주소

Path	Method	request	response	Code	설명
/lists	GET	{}	[{dr_id, de_name, dr_pid, user_id}]	200 성공 401 실패(토큰 인증 실패)	사용자 디렉토리 목록 조회
/lists	POST	{dr_name}	{dr_id, de_name, dr_pid, user_id}	201 성공 400 실패(요구되지 않는 필드값) 401 실패(토큰 인증 실패)	디렉토리 생성
/<int : 디렉토리 번호>	GET	{}	{dr_id, de_name, dr_pid, user_id}	200 성공 401 실패(토큰 인증 실패) 500 실패(존재하지 않는 디렉토리)	디렉토리 개별 조회
/<int : 디렉토리 번호>	PUT	{dr_name}	{dr_id, de_name, dr_pid, user_id}	200 성공 400 실패(요구되지 않는 필드값) 401 실패(토큰 인증 실패)	디렉토리 이름 수정
/<int : 디렉토리 번호>	DELETE	{}	{}	204 성공 401 실패(토큰 인증 실패)	디렉토리 삭제

/minutes

회의록 관련 주소

Path	Method	request	response	code	설명
/lists	GET	{}	{mn_id, mn_make_date, mn_title, mn_date, mn_place, mn_explanation, mn_memo, mn_share_link, user_id, dr_id, speaker_seq}	200 성공 401 실패(토큰 인증 실패)	회의록 목록 조회
/lists/	POST	{mn_title,dr_id} 선택: {mn_date, mn_place, mn_explanation, mn_memo, speaker_seq}	{mn_id, mn_make_date, mn_title, mn_date, mn_place, mn_explanation, mn_memo, mn_share_link, user_id, dr_id, speaker_seq}	201 성공 400 실패(요구되지 않는 필드값) 401 실패(토큰 인증 실패)	회의록 생성
/lists/like	GET	{}		200 성공	즐겨찾기 등록된 회의록 조회
/<int:mn_id >	GET	{}	{mn_id, mn_make_date, mn_title, mn_date, mn_place, mn_explanation, mn_memo, mn_share_link, user_id, dr_id, speaker_seq}	200 성공 401 실패(토큰 인증 실패) 500 실패(존재하지 않는 회의록)	회의록 조회
/<int:mn_id >	PUT	선택: {mn_title, dr_id, mn_date, mn_place, mn_explanation, mn_memo, speaker_seq}	{mn_id, mn_make_date, mn_title, mn_date, mn_place, mn_explanation, mn_memo, mn_share_link, user_id, dr_id, speaker_seq}	200 성공 400 실패(요구되지 않는 필드값) 401 실패(토큰 인증 실패)	회의록 수정
/<int:mn_id >	DELETE	{}		204 성공 401 실패(토큰 인증 실패)	회의록 삭제
/share/link	POST	{mn_id}	{}		공유 링크 생성
/create/with/share/ link/str:mn_share_link	GET	{}	{}		공유 링크로 회의록 화자 조회
/create/with/share/ link/str:mn_share_link	POST	{dr_id,speaker_seq}	{}		화자 선택 후 회의록 복사
/search?keyword=검색어	GET	{}	{}		내 회의록 제목,메모 등으로 검색
/result/< int:mn_id >	GET	{}	{keyword, summary, feedback}	200 성공 실패시 회의록 테이블 speaker_seq설정 되어있는지 확인	회의 결과(키워드, 요약문, 피드백) 조회
/result/recent	GET	{}	{최근 5회 hate_speech_rate, speech_rate}	200 성공	사용자 최근 5개 회의록 결과 내용 조회

/minutes/<int:mn_id >/bookmark

북마크 관련 주소

Path	Method	request	response	code	설명
/lists	GET	{}	{bm_seq,bm_start, bm_end,bm_name,mn_id}	200 성공 401 실패(토큰 인증 실패)	북마크 목록 조회
/lists	POST	{bm_start,bm_end,bm_name}	{bm_seq,bm_start, bm_end,bm_name,mn_id}	201 성공 400 실패(요구되지 않는 필드값) 401 실패(토큰 인증 실패)	북마크 생성
/<int:bm_seq >	GET	{}	{bm_seq,bm_start, bm_end,bm_name,mn_id}	200 성공 401 실패(토큰 인증 실패) 500 실패(존재하지 않는 북마크)	북마크 조회
/<int:bm_seq >	PUT	선택:{bm_start,bm_end,bm_name}	{bm_seq,bm_start, bm_end,bm_name,mn_id}	200 성공 400 실패(요구되지 않는 필드값) 401 실패(토큰 인증 실패)	북마크 수정
/<int:bm_seq >	DELETE	{}		204 성공 401 실패(토큰 인증 실패)	북마크 삭제

/minutes/<int:mn_id >/speaker

화자 관련 주소

Path	Method	request	response	code	설명
/lists	GET	{}	{speaker_seq,speaker_name,mn_id}	200 성공 401 실패(토큰 인증 실패)	화자 목록 조회
/<int:speaker_seq >	GET	{}	{speaker_seq,speaker_name,mn_id}	200 성공 401 실패(토큰 인증 실패) 500 실패(존재하지 않는 화자)	화자 조회
/<int:speaker_seq >	PUT	{speaker_name}	{speaker_seq,speaker_name,mn_id}	200 성공 400 실패(요구되지 않는 필드값) 401 실패(토큰 인증 실패)	화자 수정
/<int:speaker_seq >	DELETE	{}		204 성공 401 실패(토큰 인증 실패)	화자 삭제

/voice/recognition

음성 인식 & 감정 인식 관련 주소

Path	Method	request	response	code	설명
/lists/int:mn_id	GET	{}	{all}		특정 회의록 음성인식 전체 조회
/lists/int:mn_id	POST	{speaker_cnt} 총 화자 수	{all}		음성 인식 생성
/lists/int:mn_id	DELETE	{}	{ }		특정 회의록 음성인식 결과 전체 삭제
/int:mn_id/int:vr_seq	GET	{}			특정 문장 조회
/int:mn_id/int:vr_seq	PUT	{vr_text/vr_start/ vr_end/speaker_seq}			특정 문장 수정 (시간, 텍스트, 화자)
/int:mn_id/int:vr_seq	DELETE	{}			특정 문장 삭제
/int:mn_id/int:vr_seq	POST	{vr_text,vr_start, vr_end,speaker_seq}			특정 문장 생성 되긴하는데 seq 안맞아서 일단 보류
/int:mn_id/search?keyword=검색어	GET	{}	{}		음성인식 결과 검색
/emotion/int:mn_id	POST	{}	{}	200 성공	감정인식 실행, 키워드, 요약, 언어 유형 분류, 말빠르기 계산