스며들다) REST API 작성

사이드프로젝트 이름이 스며들다로 결정되었다.
기능도 정리가 다 되어서 Rest API를 작성했다.

마이페이지/ 회원정보 수정/ 좋아요한 게시글/ 작성게시글 - 하경

• **PUT** 유저아이디 수정 후 확인 버튼 클릭

  /my/userId

  Request body

  {
  	data: "userId"
  }

  Response 200 : OK

  {
  	success: true,
  	message: "수정되었습니다."
  }

  Response 401 : ERR

  {
  	success: false,
  	message: "accessToken이 만료되었습니다."
  }

  **Response** 500 : ERR

  // 수정에 실패했을 경우

• POST 유저이메일 입력 후 인증메일 발송 클릭

  /my/email-check

  Request body

  {
  	data: "userEmail"
  }

  **Response** 200 : OK

  {
  	success: true,
  	message: "인증메일 발송 성공"
  }

  Response 400 : ERR

  {
  	success: false,
  	message: "인증메일 발송 실패"
  }

• **PUT** 인증완료 후 확인 버튼 클릭

  my/email

  Response 200: OK

  {
  	success: true,
  	message: "인증메일을 발송 완료"
  }

  Response 401 : ERR

  {
  	success: false,
  	message: "accessToken이 만료되었습니다."
  }

  **Response** 500 : ERR

  // 수정에 실패했을 경우

• **PUT** 유저비밀번호 수정 후 확인 버튼 클릭

  /my/password

  Request body

  {
  	data: "userPW"
  }

  Response 200 : OK

  {
  	success: true,
  	message: "수정되었습니다."
  }

  Response 401 : ERR

  {
  	success: false,
  	message: "accessToken이 만료되었습니다."
  }

  **Response** 500 : ERR

  // 수정에 실패했을 경우

• POST 프로필 이미지 변경

  /my/profile

  Request body

  {
  	image: data
  }

  Response 200 : OK

  {
  	success: true,
  	message: "수정되었습니다."
  }

  Response 400 : ERR

  {
  	success: false,
  	message: "accessToken이 만료되었습니다."
  }

  Response 500 : ERR

  수정X

• **GET** 좋아요한 게시글 불러오기

  /my/liked-posts

  Response 200: OK

  {
  	userId: "usreId",
  	postId: "postid",
  	title: "postTitle",
  	content: "content",
  	tags: "tags",
  	createdAt: "2021-02-03"
  }

  Response 400: ERR

  {
  	success: false,
  	message: "accessToken이 만료되었습니다."
  }

  Reponse 500 : ERR

  서버에러

• **GET** 작성한 게시글 목록 불러오기

  /my/posts

  Response 200: OK

  {
  	userId: "usreId",
  	postId: "postid",
  	title: "postTitle",
  	content: "content",
  	tags: "tags",
  	createdAt: "2021-02-03"
  }

  Response 400: ERR

  {
  	success: false,
  	message: "accessToken이 만료되었습니다."
  }

  Reponse 500 : ERR

  서버에러

  마이페이지 REST API인데, 코드스테이츠에서 프로젝트를 할 때 작성시 유의사항을 유념하면서 작성해주었다.
  

• 엔드포인트를 RESTful하게 디자인했나요?

• 엔드포인트에 hypen case를 사용하고 있나요?

• 엔드포인트에는 camelCase 또는 snake_case를 사용하지 않습니다.

• GET 요청의 엔드포인트 파라미터에 민감한 정보가 노출되고 있지는 않나요?
  /users?apikey=topsecret 형태로 절대 노출되면 안됩니다.

• GET 요청에 Body(본문)값을 보내는 경우는 없나요?

• HTTP 메서드를 API가 가지는 목적에 맞게 사용하고 있나요?

• GET, POST 두 가지만 사용하고 있지는 않나요?

• 엔드포인트가 일관된 규칙을 띄고 있나요?

• 특정 요청에서는 복수, 특정 요청에 대한 엔드포인트는 단수가 아닌지 확인해주세요.

• 기획을 바탕으로 API 문서를 올바르게 작성했나요?