RESTful API

내 공부는 내가 한다, 내공내한…

정리된 내용은 “인프런-Spring Cloud로 개발하는 마이크로서비스 애플리케이션(MSA)” 강의를 기반으로 합니다.

RESTful Web Service 단계

LEVEL 0

필요한 리소스를 웹 서비스로 경유해 전달받는 최소한의 목적만 달성. URL에 action을 바로 노출시킨 형태

ex)

• http://server/getPosts
• http://server/deletePosts
• http://server/doThis

LEVEL 1

필요한 리소스를 URL에 적절하게 표기함. URL의 형식은 올바르나 HTTP Methods를 사용하고 있지 않음

ex)

• http://server/accounts
• http://server/accounts/10

LEVEL 2

리소스를 표현하는 적절한 URL 형식, 그리고 서비스의 형태, 작업의 용도 및 종류에 맞는 적절한 HTTP Methods를 사용 추가적으로 반환 값의 성공/실패 여부를 에러코드로 분기하여 표현

• Request 시 GET, POST, PUT, DELETE Methods 사용
• Response는 200, 400, 404, 500 등의 에러코드로 분기

LEVEL 3

LEVEL2 + HATEOAS 리소스와 함께 다음 단계에서 어떤 작업을 할 수 있는지를 반환(Data + Next Possibel Actions)

예를 들어 회원가입 요청 성공적으로 반환할 경우 여기에 다음 단계에서 요청할 수 있는 작업을 함께 반환 클라이언트는 서버가 제공하는 기능을 모두 확인할 필요 없음. 바로 다음 요청 가능한 URI 값을 알 수 있음.

RESTful Web Service 개발 시 고려 사항

1. Consumer First : 개발자가 아닌 API를 사용하는 소비자(외부 시스템, FE 등) 입장에서 간단 명료한 API 설계 필요
2. Make best use of HTTP : HTTP Method, 요청/응답 타입, 헤더 값 등을 잘 활용할 수 있어야 함
3. Request Methods : 작업의 종류에 따라 GET, POST, PUT, DELETE로 적절하게 분기 필요

4. Response Status : 처리 상태에 따라 응답 코드(200, 404, 400, 201, 401 등)로 의미를 담을 수 있어야 함

   • 만약 없는 데이터를 조회할 경우 서버 상에 문제가 없어 작업은 성공적으로 수행된 것이므로 500번대, 200번대 보다는 404(No Data)를 반환하는 방법을 채택할 수 있음
5. No secure info in URI : 보안과 관련된 정보는 바로 노출되는 URI에 담지 말 것. Spring Security등을 사용하여 토큰으로 전달 가능.

6. Use plurals : 리소스에 대해 복수 형태의 URI가 권장됨

   • /users
   • /users/1
7. Use nouns for resources : action을 의미하는 동사 형태보다는 resource를 의미하는 명사 형태를 쓸 것. URI만으로 어떤 리소스를 쓰는지 알 수 있음
8. Define a consistent approach : 일괄된 End Point를 사용할 것(진입점을 단일화). API Gateway 사용하여 실현 가능.