API(Application Programming Interface) | 토스페이먼츠 개발자센터

CS | API, REST API, REST 설계 규칙

[네트워크] REST API란? REST, RESTful이란?

API(Application Programming Interface)

• 애플리케이션이나 시스템 간에 상호작용하고 데이터를 교환할 수 있게 해주는 규칙과 도구의 집합
• 서로 다른 소프트웨어 컴포넌트가 통신할 수 있도록 하는 중간자 역할

REST API(Representational State Transfer API)

• REST 아키텍처 스타일을 따르는 API

• 자원을 이름으로 구분하여 해당 자원의 상태를 주고받음

• JSON 데이터 형식을 사용해서 브라우저와 호환성 좋음

• HTTP 프로토콜을 기반으로 표준화된 인터페이스 제공

• HTTP 메서드(GET, POST, PUT, DELETE 등)를 사용하여 리소스에 대한 작업을 정의

• 클라이언트-서버 구조

• 무상태(Stateless) 통신

  • 서버는 클라이언트의 상태를 저장하지 않으며, 각 요청은 독립적

  설계 규칙

  1. 리소스 중심의 URI 설계
     • 리소스는 명사로 표현하고, 복수형을 사용
       • 예: /users, /products, /orders
  2. 요청 구성
     • header: 서버에게 정보를 전달하고, 인증 또는 데이터 타입을 포함
     • data: 바디(Body) 또는 메시지로, 서버에게 보내는 정보
  3. HTTP 메서드 사용
     • GET: 리소스 조회
     • POST: 리소스 생성
     • PUT: 리소스 전체 수정
     • CATCH: 리소스 부분 수정
     • DELETE: 리소스 삭제
  4. HTTP 상태 코드 사용
     • 적절한 HTTP 상태 코드를 사용하여 요청의 결과를 표현
     • 200 OK: 성공
     • 201 Created: 생성 성공
     • 204 No Content: 성공했지만 응답 본문 없음
     • 400 Bad Request: 잘못된 요청
     • 401 Unauthorized: 인증 필요
     • 403 Forbidden: 권한 없음
     • 404 Not Found: 리소스 없음
     • 500 Internal Server Error: 서버 오류