REST API

• REST API 란 ? ( Representational State Transfer API )
• API ( application Programming Interface ) 란 ?
  • 데이터와 기능의 집합을 제공하여 컴퓨터 프로그램간 상호작용을 촉진하며, 서로 정보를 교환가능 하도록 하는 것
• REST API 정의
  • REST 기반으로 서비스 API 를 구현하는 것
  • 최근 openAPI , 마이크로 서비스 등을 제공하는 업체 대부분은 REST API 를 제공

REST API 의 특징

• 사내 시스템들도 REST 기반으로 시스템을 분산해 확장성과 재사용성을 높여 유지보수 및 운용을 편리하게 할 수 있다.
• REST 는 HTTP 표준을 기반으로 구현하므로, HTTP를 지원하는 프로그램 언어로 클라이언트, 서버를 구현할 수 있다.
• 즉, REST API를 제작하면 델파이 클라이언트 뿐 아니라, 자바, C#, 웹 등을 이용해 클라이언트를 제작할 수 있다.

REST API 설계 기본 규칙

1.  URI 는 정보의 자원을 표현해야 한다.
   1. resource 는 동사보다는 명사, 대문자 보다는 소문자 사용
   2. resource 의 도큐먼트 이름으로는 단수 명사를 사용
   3. resource 의 컬렉션 이름으로는 복수 명사를 사용
   4. resource 의 스토어 이름으로는 복수 명사를 사용
2. 자원에 대한 행위는 HTTP Method ( GET, PUT, POST, DELETE )로 표현한다.
   1. URI 에 HTTP Method 가 들어가면 안된다.
      • GET / members / delete / 1 -> DELETE /members/1
   2. URI 에 행위에 대한 동사 표현이 들어가면 안된다
   3. 경로 부분 중 변하는 부분은 유일한 값으로 대체한다.

REST API 설계 규칙

1.  슬래시 구분자(/ )는 계층 관계를 나타내는데 사용한다.
2. URI 마지막 문자로 슬래시(/ )를 포함하지 않는다.
3. 하이픈(- ) 은 URI 가독성을 높이는데 사용
4. 밑줄 ( _ ) 은 URI 에 사용하지 않는다.
5. URI 경로에는 소문자가 적합하다.
6. 파일확장자는 URI 에 포함하지 않는다.
7. 리소스 간에는 연관 관계가 있는 경우

 

출 처 : gmlwjd9405.github.io/2018/09/21/rest-and-restful.html