간단하게 API 란?

Wonju·2022년 1월 19일
0

API란?
(Application Programming Interface)

사용규칙을 제공하는 것.

프론트엔드는 사용자가 눈으로 보는 화면을 만들고,
백엔드는 화면에 나타는 실질적인 내용들을 관리한다.

이미지를 예시로

  • 클라이언트는 서비스를 요청 (Request)하는 프론트엔드를,
  • 서버는 요청받은 서비스에 응답 (Response)하는 백엔드를 의미한다.

"1번 글 보여줘", "로그인해줘" 등 프론트엔드는 다양한 정보를 백엔드에 요청하게 되고 백엔드는 DB에서 정보를 찾아 꺼내주는데,
이러한 다양한 요청들을 규칙에 맞게 요청하고 전달하기 위한 체계를 API 라고 한다.


클라이언트 입장에서 보는 API

클라이언트가 서버에 요청(Request)은 4가지로 이루어져 있다.

  • CREATE
  • READ
  • UPDATE
  • DELETE
    이며, 앞글자를 따서 CRUD 라고 한다.
    위 4가지는 데이터를 다룰 때의 기준이 되는 것들로 매우 중요하다.

만약 게시글에 대해 위 4가지 요청을 한다면

  • 게시글 만들어줘
  • 게시글 읽어줘
  • 게시글 업뎃해줘
  • 게시글 삭제해줘
    인 셈이다.

서버 입장에서 보는 API

요청을 받은 서버는 크게 2가지로 응답을 한다.

  • 요청이 잘 되었고 잘 처리했다고 응답
  • 요청이 뭔가 이상하니 확인 부탁한다고 응답

요청이
1. 요청한 게시글이 존재하면 문제없이 READ하지만,
2. 요청한 게시글이 존재하지 않거나
3. 서버상의 문제로 게시글을 확인할 수 없을 경우

와 같이 클라이언트의 문제이거나 서버의 문제 등 다양한 경우가 있기 때문에
응답도 요청과 같이 체계적으로 관리하기 위해 숫자 를 통해 관리한다.

  • 200번대 코드 (201, 202,…) : 잘 됐다
  • 400번대 코드 (401, 404,…) : 클라이언트 요청 상의 오류
  • 500번대 코드 (500, 501,…) : 서버 응답 상의 오류

API란 클라이언트가 특정 기능을 이용하기 위해 어떤 주소로 요청을 보내면 서버가 응답을 해주는 체계이다.


Open API

Open API는 서버가 제공하는 다양한 기능을 누구나 이용할 수 있도록 공개해놓은 API이다.
Open API는 사용자들이 API를 원활하게 사용할 수 있도록 API 가이드를 제공한다.

공통적으로 요청 응답에 대한 정보가 존재하는데,

1. 요청

  1. 주소 : 어디로 정보를 전달해야할지 API서버의 주소 제공
  2. 전송방식 : GET(주소창에 입력) 과 POST(url이 아닌 내부적으로 전송)
  3. 보낼 것 : 사용자가 필요한 정보(예: 검색어, 정렬방식 등)

2. 응답

  1. 형식: JSON, XML(많이 안쓰인다고 함)

    잠깐! JSON이란?

    Javascript Object Notation의 약자로, 객체 형태를 띄며, JS외 다른 언어에서도 사용할 수 있는 표준

  2. 응답에 대한 설명: 제목, 썸네일, 사진 등등



참고 사이트
https://assaeunji.github.io/development/2020-08-29-api/

profile
안녕하세여

0개의 댓글