루이의 개발 블로그

REST API 란? 본문

기술용어

REST API 란?

루이96 2023. 10. 22. 12:14

 

 

웹에서 데이터를 전송 및 처리하는 방법을 정의한 인터페이스
처리방식은 REST에서 URL을 통해 정의되며 직관적이다.

REST 구성

  • 자원 : URL
  • 행위 : HTTP Method
    • Create : POST
    • Read : GET
    • Update : PUT
    • Delete : DELETE

회원정보를 가져오는 URI

GET /members/show/1 (x) show는 행위입니다. 보겠다는 의도는 알겠지만 권장하지 않습니다.
GET /members/1 (o)|

회원을 추가할 때

GET /members/insert/2 (x) GET 메서드는 리소스 생성에 맞지 않습니다.
POST /members/2 (o)|

사용시 주의사항


URI 마지막 문자로 슬래시(/)를 포함하지 않는다.

http://restapi.example.com/houses/apartments/ (X)  
http://restapi.example.com/houses/apartments (0)

파일 확장자는 URI에 포함시키지 않는다.

하이픈은 URI 가독성을 높이는데 사용

밑줄은 URI에 사용하지 않는다.

 

'기술용어' 카테고리의 다른 글

TCP 3-way Handshaking  (0) 2023.10.22
STDOUT  (0) 2023.10.22
payload (페이로드)  (0) 2023.10.22
ORM  (0) 2023.10.22
DX  (0) 2023.10.22