Rest Api

목차

1.Rest Api?

2.Rest Api 특징

3.Rest Api의 설계 예시

 

 

1.Rest Api?

 

우선은 RestApi를 알기전에 Api가 무엇인지를 알아야 합니다. 

• Api 는 "Application Programming Interface"의 약자로, 소프트웨어 애플리케이션 간에 상호 작용할 수 있도록 하는 인터페이스를 말합니다.

그리고 Rest는 Representational State Transfer의 약자로 자원을 이름으로 구분하여 해당 자원의 상태를 주고받는 모든 것을 의미합니다.

 

2.Rest Api 특징

 

Rest Api의  특징으로는 다음과 같습니다.

• 모든 것을 자원으로 표현
• Sever-Client 구조
• Stateless
• Cacheable
• Layered System

3.Rest Api 의 설계 예시

 

Rest Api를 작성하는데 있어서는 몇가지의 작성 규칙이 있습니다.

• URI는 동사보다는 명사를, 대문자보다는 소문자를 사용한다.
  • http://www.xxxx.com/Css (X) 
  • http://www.xxxx.com/ccs(0)
• 마지막에 슬래시 (/)를 포함하지 않는다.
  • http://www.xxx.com/member/ (X)
  • http://www.xxx.com/member(O) 
• 언더바 대신 하이폰을 사용
  • http://www.xxx.com/member_page (X) 
  • http://www.xxx.com/member-page(O)
• 파일확장자는 URI에 포함하지 않는다
  • http://www.xxx.com/member/photo.jpg (X)
  • http://www.xxx.com/member (O)
• 행위를 포함하지 않는다
  • http://www.xxx.com/detail-member/1 (X)
  • http://www.xxx.com/member/1 (O)