🚡

공통 API 스펙 및 URL Resouce

생성자

우선순위

1순위

태그

API

Backend

Frontend

💚해결 완료

조수연

최민석

김동건

남명훈

이소진

황일용

완료

Yes

공통 API 스펙 정의

백엔드 팀이 생각한 request, response 템플릿 형태입니다.

request


// Header
{
	"Content-type" : "application/json",
	"Authorization" : "Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdtiC_Ug0ngasdasdsadasdasdasd"
}

// Body
{
  "message": "POST_DELETE_SUCCESS",
  "serverDateTime": "2021-10-18T18:24:47.5609763",
  "data": {
			"username" : "극락동건",
			"password" : "computer1"
	}
}

Response


// Header
{
	"Content-type" : "application/json"
}


// Body
{
  "message": "POST_DELETE_SUCCESS",
  "serverDateTime": "2021-10-18T18:24:47.5609763",
  "data": {
    "id": 1,
    "email": "wrjs@naver.com"
  }
}

헤이오티스 적용에 대해

아래의 사진처럼 body에 link를 추가하여 기능에 대한 세부적인 사항을 알려주는 것을 헤이오티스라고 합니다!

URI resource 정의

uri를 정의할 때 어떤 방식으로 resource를 추가할지 통일해야 될 것 같습니다!

Backend → Front로 넘어가는 Server URL 정의

Front → Client로 넘어가는 Client URL 정의

밑의 url은 예시 사항입니다~~

server url


api/v1/members/{memberId}

api/v1/albums/{albumId}/posts/{postId}/comments/{commentId}

front url


/members/김동건

/albums/동건이가족/posts/2021일기

내일 한번 강의 내용만 따라서 진행을 해보기!!

공통 API 스펙 및 URL Resource 확인하시고, 더 좋은 방법이나 본인이 생각한 방법이 있다면 comment 남겨주세용용용~