[ASP.Net Core API] REST API와 RESTful 및 CRUD개념

RESTful이란?

'REST API'를 제공하는 서비스를 'RESTful'한 API라고 말할 수 있으며,

REST 규칙을 따르는 서비스를 'RESTful'이라 칭한다.

 

---

 

CRUD란?

Create, Read, Update, Delete 4개의 기능을 칭하는 용어다.

이름	SQL	조작	METHOD
Create	INSERT	생성	POST
Read	SELECT	읽기	GET
Update	UPDATE	갱신	PUT
Delete	DELETE	삭제	DELETE

 

---

 

REST API

REpresentational State Transfer API

나타낸 + 상태 + 전달 = 전달 상태를 나타낸 API

REST API는 API의 전달 규칙을 칭한다.

 

---

REST API 구성

1. 자원(resource) - URI
2. 행위(verb) - METHOD
3. 표현(representation)

GET     /sample/member

---

REST API 설계 규칙

• URI는 정보의 자원을 표현해야 하며 명사로 표기하며 행위는 URI로 표기하지 않음.
  • Ex) POST     /sample/member/delete (X)
  • EX) DELETE  /sample/member           (O)

 

• 행위는 반드시 Method( POST, GET, PUT, DELETE )로 표현.
  • Ex) POST   /sample/member  (회원 생성)
  • Ex) GET     /sample/member  (회원 목록)
  • Ex) PUT     /sample/member  (회원 정보 수정)
  • Ex) DELETE /sample/member  (회원 탈퇴)

 

• 슬래시 구분자( / )는 계층 관계를 나타내는데 사용.
  • Ex) GET /sample/member

 

• URI 마지막 문자로 슬래시( / )를 포함하지 않음.
  
  • Ex) GET /sample/member/ (X)
  • Ex) GET /sample/member  (O)

 

• 하이픈( - )은 URI 가독성을 높이는데 사용.
  
  • 밑줄( _ )은 폰트나 특정 상황에서 가려지는 경우가 있어 하이픈(-)을 사용한다.

 

• 밑줄( _ )은 URI에 사용하지 않음
• URI 경로에는 소문자가 적합하다.
  
  • URI는 대소문자를 구분하기 때문에 소문자만 사용한다.

 

• URI에는 파일확장자를 포함하지 않음.
  • /sample/virtualgiraffe-t.ico (X)
  • /sample/virtualgiraffe-t      (O)