REST API가 뭔가요? - 인터페이스, API, REST API, HTTP method

REST API가 뭔가요? - 인터페이스, API, REST API, HTTP method

인터페이스란?

: 소통창구

사용자가 명령을 입력하게 해주고, 실행결과를 출력해주는 기능을 함.

어떤 기계를 만들면 사용자가 그 기능을 전부 활용할 수 있도록 제어장치를 만들어야 함.

(TV-리모컨, 자판기-버튼, 컴퓨터-키보드와 마우스처럼. )

웹 애플리케이션을 만드는 경우, 버튼, 스크롤바, 슬라이더, 브라우저 창 등 사용자가 앱을 제어하도록 인터페이스를 제공한다. (UI : User Interface, 사용자 인터페이스)

마찬가지로 기계-기계, 소프트웨어-소프트웨어 사이에서도 수많은 요청과 정보교환이 이루어지는데, 이를 위한 창구를 API라고 한다.

API란?

Application Programming Interface.

: 소프트웨어가 다른 소프트웨어로부터 지정된 형식으로 요청/명령을 받을 수 있는 창구(인터페이스)

예를 들어 기상청 서버로부터 기상정보를 제공받으려면 기상청이 지정한 형식으로 요청해야 한다.

REST API란?

REST한 형식의 API.

: 정보를 주고받는 데 있어 개발자들 사이에 널리 쓰이는 형식의 일종.

HTTP 요청을 보낼 때, 어떤 URI에 어떤 메소드를 사용할지 개발자 사이에 널리 지켜지는 약속이다

(우체국에서 택배를 보내려면 송장이라는 '형식'을 작성해야 하는 것처럼)

※ 기술, 제품이 아닌 '형식'이기 때문에 프로그래밍언어/라이브러리/프레임워크 ... 에 관계없이 이 형식에 맞춰 기능을 만들 수 있다.

REST API의 핵심은?

"각 요청이 어떤 동작/정보를 위한 것인지를, 요청을 보내는 주소의 모습 만으로 파악할 수 있다" 이다.

URL을 아무렇게나 짜도 동작만 잘 하면 서비스 기능에는 문제가 없을 것이다.

하지만 서비스는 개발자 혼자서 만드는 것이 아니고, 혼자 만들더라도 그 서비스를 이용할 다른 개발자들이 그 API를 이용하기 어려워질 수 있다.

• 요청하는 정보(명사)를 URL로 활용한다.
  • URI는 동사가 아닌 명사들로 이루어져야 한다
• 고유번호 (숫자)는 index로 이해할 수 있다.
• 예를 들어 https://www.codingschool.com/classes/2/students/15 와 같이 URL을 구성하면, 이 주소를 보고 'codingschool의 2반 15번 학생의 정보를 요청하는 거구나'라고 쉽게 이해할 수 있다.(URI, 자원을 구조와 함께 나타내는 구분자)

서버에 REST API로 요청을 보낼 떄는 HTTP 규약에 따라 신호를 전송한다.

HTTP method

: HTTP로 요청을 보낼 때 사용하는 여러 메서드.

GET, HEAD, POST, PUT, DELETE, CONNECT, OPTIONS, TRACE, PATCH ... 가 있다

우체국에서 택배를 보낼 때 일반, 등기, 특송 등이 있는 것과 같다.

• RestAPI에서는 이 중 GET, POST, PUT, DELETE (+ PATCH)를 사용한다.
  • POST, PUT, PATCH는 BODY라는 주머니가 있어, GET또는DELETE보다 정보들을 더 많이, 안전하게 감춰서 전송할 수 있다.

※ POST만으로도 읽기, 쓰기, 삭제 등을 다 할 수 있지만, 누구든 요청의 의도를 쉽게 파악할 수 있도록 목적에 따라 HTTP method를 구분해 사용해야 한다.

즉 Restful하게 URL을 만들어, HTTPmethod만으로도 구분 가능한 요청들로 구성해야 한다

HTTP method를 사용한 REST API의 CRUD 구현

• GET : 데이터를 조회 (Read)

  • GET, https://www.codingschool.com/classes/2/students

    : codingschool의 2반 학생들을 조회하겠다는 요청

• POST : 데이터를 추가(Create)

  • POST, https://www.codingschool.com/classes/2/students

    BODY 에 새 학생의 정보

    : codingschool의 2반 학생에 새로운 정보(학생)을 추가한다는 요청

• PUT / PATCH : 데이터를 변경 (Update)

  • PUT / PATCH, https://www.codingschool.com/classes/2/students/14

    BODY에 수정할 학생의 정보

    : codingschool의 2반의 14번 학생 정보를 변경하겠다는 요청

  • 사용법은 회사마다, 개발자마다 조금씩 다르지만

    • PUT : 정보를 통째로 갈아 끼울 때 사용
    • PACTH : 정보 중 일부를 특정 방식으로 변경할 때 사용

• DELETE : 데이터를 삭제(Delete)

  • DELETE, https://www.codingschool.com/classes/2/students/3

    : codingschool의 2반의 3번 학생 정보를 삭제하겠다는 요청

심화학습 : REST API에 대해 더 공부하기

그런 RestAPI로 괜찮은가, restful api design guidelines 라는 키워드로 검색하면 좋은 자료가 있으니 참고.

추가 : API 의 의미?

API의 의미가 헷갈려서 그룹원 분들께 질문을 드려 보았다.

(Pyro, August 감사합니다🙇‍♀️🙇‍♀️!!)

API는 ''인터페이스''라고 이해하면 된다. (인터페이스 = 연결다리.)

프로그램을 만들고 그것을 외부에서 사용할 때, 사용하는 수단을 API라고 한다.

그 내부를 까보지 않아도 (로직을 몰라도) 사용할 수 있어야 인터페이스라고 할 수 있다.

즉, 내부 코드를 몰라도 사용할 수 있도록 '외부사용자'에게 연결다리를 놓아주는것을 모두 API라고 할 수 있다.

자바 단위에서의 API는 함수 단위 (개발자 입장에서)이며,

우리가 사용하는 ArrayList 같은 것도 import 해서 쓰니 api라고 할 수 있다.

마찬가지로, 내가 스스로 자바로 잘 작성한 무언가를 다른 사람이 import해서 사용한다면 그것도 api이다.