본문 바로가기
프로젝트

API 명세서, ERD 작성하기

by 해룸 2024. 2. 2.

 

기능 api url method request header request response response header
회원가입 /sign-up post   {
email
password
name
age
gender
}
{
message: "회원가입을 축하드립니다."}
 
로그인 /sign-in post   {
email
password
}
{
message:"ㅇㅇ님 환영합니다!"}
{ “authorization”: “Bearer eyJhbGciOiJIUzI1NiIsIn…” }
사용자 조회 /users get {
  authorization: 'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOjEsImlhdCI6MTY5MTA1NTc5OH0.2bM9s-Vv312rgkRzQiWLy4ASa0lWk5TOEGlEvNOa67k'
}
{} {
data:{
usreId
email
createdAt
updatedAt
userInfos:{
name
age
gender
}
}
}
 
사용자 정보 변경 /usres patch {
  authorization: 'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOjEsImlhdCI6MTY5MTA1NTc5OH0.2bM9s-Vv312rgkRzQiWLy4ASa0lWk5TOEGlEvNOa67k'
}
{
name
age
gender
}
{
  "message": "사용자 정보 변경에 성공하였습니다."
}
 
이력서 생성 /resumes post {
  authorization: 'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOjEsImlhdCI6MTY5MTA1NTc5OH0.2bM9s-Vv312rgkRzQiWLy4ASa0lWk5TOEGlEvNOa67k'
}
{
  "title": "이력서제목.",
  "content": "내용입니다."
status: enum으로 설정할것
}
{
  "message": "이력서가 성공적으로 저장되었습니다."
}
 
내 이력서 목록 조회 /resumes get {
  authorization: 'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOjEsImlhdCI6MTY5MTA1NTc5OH0.2bM9s-Vv312rgkRzQiWLy4ASa0lWk5TOEGlEvNOa67k'
}
  {
postId
title
createdAt
updatedAt
}
 
내 이력서 수정 /resumes/:resumeId patch {
  authorization: 'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOjEsImlhdCI6MTY5MTA1NTc5OH0.2bM9s-Vv312rgkRzQiWLy4ASa0lWk5TOEGlEvNOa67k'
}
{
title
content
status
}
   
내 이력서 삭제 /resumes/:resumeId delete {
  authorization: 'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOjEsImlhdCI6MTY5MTA1NTc5OH0.2bM9s-Vv312rgkRzQiWLy4ASa0lWk5TOEGlEvNOa67k'
}
{
postId
}
   
☆ 관리자권한
이력서 목록 조회, 상태수정기능
  get, patch 관리자 middleware 생성?? {},
{status}
{
  "data": [
    {
      "postId": 2,
      "title": "2번째 타이틀입니다.",
      "createdAt": "2024-01-03T14:00:33.365Z",
      "updatedAt": "2024-01-03T14:00:33.365Z"
    },
    {
      "postId": 1,
      "title": "타이틀입니다.",
      "createdAt": "2024-01-03T13:58:59.693Z",
      "updatedAt": "2024-01-03T13:58:59.693Z"
    }
  ]
}
 
이력서 상세 조회 /resumes/:resumeId get     {
  "data": {
    "postId": 1,
    "title": "타이틀입니다.",
    "content": "내용입니다.",
    "createdAt": "2024-01-03T13:58:59.693Z",
    "updatedAt": "2024-01-03T13:58:59.693Z"
  }
}
 

 

https://drawsql.app/teams/df-15/diagrams/myresumenote