[14일차] 50일 포트폴리오 챌린지

본 포스팅은 패스트캠퍼스 환급 챌린지 참여를 위해 작성하였습니다.

https://bit.ly/43z0P6S 

패스트캠퍼스 [직장인 실무교육]

---

API 설계

API

API(application programming interface 애플리케이션 프로그래밍 인터페이스, 응용 프로그램 프로그래밍 인터페이스)는 컴퓨터나 컴퓨터 프로그램 사이의 연결이다. 일종의 소프트웨어 인터페이스이며 다른 종류의 소프트웨어에 서비스를 제공한다.

RESTful API에서 HTTP Method

• GET: 조회(받겠다)
• POST: 리소스 생성
• PUT: 리소스 전체 갱신
• DELETE: 리소스 삭
• PATCH: 리소스 일부 갱신

설계 예시

URI	HTTP	CRUE
/api/sign-up	POST	회원가입
/api/login	GET	로그인 요청
/api/articles	GET	게시글 리스트 조회
/api/articles/{article-id}	GET	게시글 단일 조회
/api/articles	POST	게시글 추가
/api/articles/{article-id}	PUT,PATCH	게시글 수정
/api/articles/{article-id}	DELETE	게시글 삭제

REST API 디자인 가이드

1. URI는 정보의 자원을 표현해야 한다
2. 자원에 대한 행위는 HTTP Method(GET, POST, PUT, DELETE)로 표현한다

1) URI는 정보의 자원을 표현해야 한다.(리소스명은 동사보다는 명사를 사용)

GET /members/delete/1

위와 같은 방식은 REST를 제대로 적용하지 않은 URI입니다. URI는 자원을 표현하는데 중점을 두어야 합니다. delete와 같은 행위에 대한 표현이 들어가서는 안됩니다.

2) 자원에 대한 행위는 HTTP Method(GET, POST, PUT, DELETE 등)로 표현

위의 잘못 된 URI를 HTTP Method를 통해 수정해 보면

DELETE /members/1

으로 수정할 수 있겠습니다.회원정보를 가져올 때는 GET, 회원 추가 시의 행위를 표현하고자 할 때는 POST METHOD를 사용하여 표현합니다.

회원정보를 가져오는 URI

    GET /members/show/1     (x)
    GET /members/1          (o)

회원을 추가할 때

    GET /members/insert (x)  - GET 메서드는 리소스 생성에 맞지 않습니다.
    POST /members       (o)

URI 설계 시 주의할 점

1) 슬래시 구분자(/)는 계층 관계를 나타내는 데 사용

<http://restapi.example.com/houses/apartments>
<http://restapi.example.com/animals/mammals/whales>

2) URI 마지막 문자로 슬래시(/)를 포함하지 않는다.

URI에 포함되는 모든 글자는 리소스의 유일한 식별자로 사용되어야 하며 URI가 다르다는 것은 리소스가 다르다는 것이고, 역으로 리소스가 다르면 URI도 달라져야 합니다. REST API는 분명한 URI를 만들어 통신을 해야 하기 때문에 혼동을 주지 않도록 URI 경로의 마지막에는 슬래시(/)를 사용하지 않습니다.

<http://restapi.example.com/houses/apartments/> (X)
<http://restapi.example.com/houses/apartments>  (0)

3) 하이픈(-)은 URI 가독성을 높이는데 사용

URI를 쉽게 읽고 해석하기 위해, 불가피하게 긴 URI경로를 사용하게 된다면 하이픈을 사용해 가독성을 높일 수 있습니다.

4) 밑줄(_)은 URI에 사용하지 않는다.

글꼴에 따라 다르긴 하지만 밑줄은 보기 어렵거나 밑줄 때문에 문자가 가려지기도 합니다. 이런 문제를 피하기 위해 밑줄 대신 하이픈(-)을 사용하는 것이 좋습니다.(가독성)

5) URI 경로에는 소문자가 적합하다.

URI 경로에 대문자 사용은 피하도록 해야 합니다. 대소문자에 따라 다른 리소스로 인식하게 되기 때문입니다. RFC 3986(URI 문법 형식)은 URI 스키마와 호스트를 제외하고는 대소문자를 구별하도록 규정하기 때문이지요.

RFC 3986 is the URI (Unified Resource Identifier) Syntax document

6) 파일 확장자는 URI에 포함시키지 않는다.

<http://restapi.example.com/members/soccer/345/photo.jpg> (X)

REST API에서는 메시지 바디 내용의 포맷을 나타내기 위한 파일 확장자를 URI 안에 포함시키지 않습니다. Accept header를 사용하도록 합시다.

GET / members/soccer/345/photo HTTP/1.1 Host: restapi.example.com Accept: image/jpg

---

PUT vs PATCH

restful API 를 사용할 때 UPDATE 하는 부분에서 PUT or PATCH 를 사용한다.

두 개의 차이점

• PUT: 자원 전체 교체(자원의 모든 필드 필요)
• PATCH: 자원 부분 교체(자원의 일부 필드 필요)

예시

GET /users/1
{
	"name" : "insutance",
	"email" : "test@naver.com"
}

Update 할 때 PUT을 사용하기 위해서는 자원 내의 모든 필드가 필요하다.

하지만 자원 내의 필드 중 하나라도 빠지면 null값이 들어가게 된다.

# Good!
PUT /users/1
{
	"name" : "choi",
	"email" : "success@naver.com"
}

# result
GET /users/1
{
	"name" : "choi",
	"email" : "success@naver.com"
}

# Bad...
PUT /users/1
{
	"name" : "choi",
}

# result
GET /users/1
{
	"name" : "choi",
	"email" : null
}

여기서 PUT 과 PATCH 의 차이점이 나온다.

Update 할 때 PATCH 사용하기 위해서는 자원 내의 일부 필드만 있어도 된다.

따라서 결과는 아래와 같이 나오게 된다.

# Good!
PATCH /users/1
{
	"name" : "choi",
}

# result
GET /users/1
{
	"name" : "choi",
	"email" : "test@naver.com"
}