RestFul API

RestFul API 개념 설명

567Rabbit 2024. 5. 20. 15:06

API란?

 

API는 프로그램들이 서로 필요한 정보를 주고받고, 다양한 기능을 사용할 수 있게 도와주는 중개인 역할을 한다. 개발자들이 이 API를 사용하면, 복잡한 작업을 직접 다 하지 않고 훨씬 쉽게 프로그램을 만들 수 있다.

쉽게 말해, API는 프로그램들이 서로 도와주고, 필요한 정보를 주고받는 매개체이다.

 

 

 


Windows API란?

 

Windows API(또는 WinAPI)는 마이크로소프트 윈도우 운영 체제에서 애플리케이션을 개발할 때 사용할 수 있는 함수와 도구들의 집합이다. Windows API는 윈도우 운영 체제에서 프로그램을 만들기 위해 필요한 다양한 기능과 도구들을 제공한다. 이를 통해 개발자는 창 관리, 파일 입출력, 그래픽 처리 등 다양한 작업을 쉽게 할 수 있어요. 마치 윈도우 운영 체제와 프로그램이 서로 대화할 수 있게 해주는 언어와 같은 역할을 한다.

 

 

 

 

 

RestFul API란?

 

- Rest는 "Representational State Transfer" 의 약자로, 인터넷을 통해 데이터를 주고받기 위해 사용되는 API이다. 

- 서버나 서비스에 존재하는 모든 자원(이미지,동영상,DB자원)에 고유한 URL(URI)을 부여해 활용하는 것이다.

- 자원을 정의하고 자원에 대한 주소를 지정하는 방법론을 의미한다.

- 쉽게 말하면, 웹을 통해 서로 데이터를 주고받는 방법이다.

 

 

 

 

 

REST의 구성

  1. 자원(Resource): 데이터를 저장하고 관리하는 객체. ex) "사용자(User)"라는 자원, URL이라는 자원
  2. 행위(Method) 또는 HTTP Method : 자원을 처리하는 방법을 지정합니다.
    • GET: 자원을 조회
    • POST: 새로운 자원을 생성
    • PUT: 기존 자원을 업데이트
    • DELETE: 자원을 삭제
  3. 표현(Message): JSON, XML 등의 형태를 이용해 표현

 

 

 

 

 URL(URI) 구성 명칭

 

 

 

 

 

 

Message Format

 

 

 

** 무조건 순서는 클라이언트가 서버에 요청(Request)을 먼저, 그 다음으로 Response가 클라이언트에 돌아오는 것이다.

 

 

 

 

Response로 받아올 때 HTTP Status Codes

 

 

 

  • 200 OK: 요청이 성공적으로 수행되었습니다.
  • 201 Created: 요청이 성공적이었으며, 새로운 리소스가 생성되었습니다.
  • 204 No Content: 서버가 요청을 성공적으로 처리했지만 콘텐츠를 반환하지 않습니다.
  • 400 Bad Request: 서버가 요청의 구문을 인식하지 못했습니다.
  • 401 Unauthorized: 요청이 인증되지 않았습니다.
  • 403 Forbidden: 서버가 요청을 이해했지만 거부했습니다.
  • 404 Not Found: 서버가 요청한 리소스를 찾을 수 없습니다.

 

 

 

 

Message 주고받기 위한 JSON 문법