🔎 REST API

REST API

• REST 기반으로 서비스 API를 구현한 것
• OpenAPI. 마이크로 서비스 등을 제공하는 업체 대부분은 REST API를 제공한다.
  • Open API
    • 누구나 사용할 수 있도록 공개된 API ex 구글 맵, 공공 데이터 등
      
  • 마이크로 서비스
    • 하나의 큰 애플리케이션을 여러 개의 작은 애플리케이션으로 쪼개 변경과 조합이 가능하도록 만든 아키텍처

REST API 특징

1. 사내 시스템들도 REST 기반으로 시스템을 분산하여 확장성과 재사용성을 높여 유지보수를 편리하게 할 수 있다.

2. REST는 HTTP 표준을 기반으로 구현한다.

   → HTTP를 지원하는 프로그래밍 언어로 클라이언트, 서버를 구현할 수 있다.

3. REST API를 제작하면 자바, C#, 웹 등을 이용해 클라이언트를 제작할 수 있다.
   
   

REST API 기본 규칙

1. URI는 정보의 자원을 표현해야 한다.

2. resource: 동사 → 명사, 대문자 → 소문자

3. resource: document 이름은 단수 명사

4. resource: 컬렉션 이름은 복수 명사

5. resource: 스토어 이름은 복수 명사

• 리소스 원형
  • 도큐먼트 : 객체 인스턴스나 데이터베이스 레코드와 유사한 개념
  • 컬렉션 : 서버에서 관리하는 디렉터리라는 리소스
  • 스토어 : 클라이언트에서 관리하는 리소스 저장소

1. 자원에 대한 행위는 HTTP Method로 표현한다.

   1. URI에 HTTP Method는 들어가지 않는다.

   2. URI에 행위에 대한 동사 표현이 들어가지 않는다.

      → CRUD 기능을 나타내는 표현을 사용하지 않는다.

   3. 경로 부분 중 변하는 부분은 유일값으로 대체한다.

      → id는 하나의 특정 resource를 나타내는 고유값이다.

REST API 설계 규칙(URI)

1. 슬래시 구분자는 계층 관계를 나타낼 때 사용한다.
2. 마지막 문자에는 슬래시를 포함하지 않는다.

   1. URI에 포함되는 모든 글자는 리소스의 유일한 식별자로 사용되어야 하며 URI가 다르다는 것은 리소스가 다르다는 것이다.

      → 역으로 리소스가 다르면 URIㄷ도 달라져야 한다.

   2. REST API는 분명한 URI를 만들어 통신하기 때문에 혼동을 주지 않도록 경로 마지막에 슬래시를 넣지 않는다.

3. 가독성을 높이는데 하이픈을 사용하고 밑줄은 사용하지 않는다.
   1. 긴 URI 경로를 사용하게 된다면 하이픈을 사용하여 가독성을 올린다.
   2. 밑줄은 보기 어렵거나 밑줄 때문에 문자가 가져지는 경우도 있으므로 사용하지 않는다.
4. 경로에는 소문자가 적합하다.
   1. URI 경로에 대문자 사용은 피하는게 좋다.
5. 파일 확장자는 포함하지 않는다.
   1. REST API에서는 메시지 바디 내용의 포맷을 나타내기 위한 파일 확장자를 URI 안에 포함시키지 않는다.