REST API
REST API란?
REST 기반으로 서비스 API를 구현한 것
최근 OpenAPI(누구나 사용할 수 있도록 공개된 API: 구글 맵, 공공 데이터 등), 마이크로 서비스(하나의 큰 애플리케이션을 여러 개의 작은 애플리케이션으로 쪼개어 변경과 조합이 가능하도록 만든 아키텍처) 등을 제공하는 업체 대부분은 REST API를 제공
REST API의 특징
- 사내 시스템들도 REST 기반으로 시스템을 분산해 확장성과 재사용성을 높여 유지보수 및 운용을 편리하게 할 수 있음
- REST는 HTTP 표준을 기반으로 구현하므로, HTTP를 지원하는 프로그램 언어로 클라이언트, 서버를 구현할 수 있음
- 즉, REST API를 제작하면 델파이 클라이언트 뿐 아니라, 자바, C#, 웹 등을 이용해 클라이언트를 제작할 수 있음
REST API 설계 기본 규칙
- 도큐먼트 : 객체 인스턴스나 데이터베이스 레코드와 유사한 개념
- 컬렉션 : 서버에서 관리하는 디렉터리라는 리소스
- 스토어 : 클라이언트에서 관리하는 리소스 저장소
1. URI는 정보의 자원을 표현해야 한다
- resource는 동사보다는 명사를, 대문자보다는 소문자를 사용
- resource의 도큐먼트 이름으로는 단수 명사를 사용
- resource의 컬렉션 이름으로는 복수 명사를 사용
- resource의 스토어 이름으로는 복수 명사를 사용
ex)GET /Member/1->GET /members/1
2. 자원에 대한 행위는 HTTP Method(GET, PUT, POST, DELETE 등)로 표현
- URI에 HTTP Method가 들어가면 안됨
ex)GET /members/delete/1->DELETE /members/1 - URI에 행위에 대한 동사 표현이 들어가면 안됨 (즉, CRUD 기능을 나타내는 것은 URI에 사용하지 않음.)
ex)GET /members/show/1->GET /members/1
ex)GET /members/insert/2->POST /members/2 - 경로 부분 중 변하는 부분은 유일한 값으로 대체 (즉, :id는 하나의 특정 resource를 나타내는 고유값)
ex) student를 생성하는 route: POST /students
ex) id=12인 student를 삭제하는 route: DELETE /students/12
REST API 설계 규칙
1. 슬래시 구분자(/ )는 계층 관계를 나타내는데 사용
- Ex)
http://restapi.example.com/houses/apartments
2. URI 마지막 문자로 슬래시(/ )를 포함하지 않음
- URI에 포함되는 모든 글자는 리소스의 유일한 식별자로 사용되어야 하며 URI가 다르다는 것은 리소스가 다르다는 것이고, 역으로 리소스가 다르면 URI도 달라져야 함
- REST API는 분명한 URI를 만들어 통신을 해야 하기 때문에 혼동을 주지 않도록 URI 경로의 마지막에는 슬래시(/)를 사용하지 않음
Ex) http://restapi.example.com/houses/apartments/ (X)
3. 하이픈(- )은 URI 가독성을 높이는데 사용
- 불가피하게 긴 URI경로를 사용하게 된다면 하이픈을 사용해 가독성을 높임
4. 밑줄(_ )은 URI에 사용하지 않음
- 밑줄은 보기 어렵거나 밑줄 때문에 문자가 가려지기도 하므로 가독성을 위해 밑줄은 사용 X
5. URI 경로에는 소문자가 적합
- URI 경로에 대문자 사용은 피하도록 함
- RFC 3986(URI 문법 형식)은 URI 스키마와 호스트를 제외하고는 대소문자를 구별하도록 규정하기 때문
6. 파일확장자는 URI에 포함하지 않음
- REST API에서는 메시지 바디 내용의 포맷을 나타내기 위한 파일 확장자를 URI 안에 포함시키지 않음
- Accept header를 사용
- Ex)
http://restapi.example.com/members/soccer/345/photo.jpg (X) - Ex)
GET / members/soccer/345/photo HTTP/1.1 Host: restapi.example.com Accept: image/jpg (O)
7. 리소스 간에는 연관 관계가 있는 경우
- /리소스명/리소스 ID/관계가 있는 다른 리소스명
- Ex)
GET : /users/{userid}/devices (일반적으로 소유 ‘has’의 관계를 표현할 때) https://gmlwjd9405.github.io/2018/09/21/rest-and-restful.html
응답상태코드
코린이