API 서로 다른 소프트웨어가 어떤 기능과 요청을 응답할 때 사용하는 규칙을 말한다. 보통 API 를 쓴다고 하면 클라-서버 나 프론트-서버 로 생각한다. 하지만 꼭 그런 것은 아니다.

예시) 주방(서버), 손님(클라이언트), 주문하는 태블릿PC(API)

HTTP 웹이란 환경에서 클라이언트와 서버가 서로 데이터를 주고받기 위해서 정해 놓은 규칙이다.

• 구성요소
  • Header는 부가 정보이다. 내가 어떤 데이터를 보내는데 데이터의 형태는 어떤 것이라는 부가 정보가 들어간다. 메타데이터라고도 표현한다.
  • Body는 HTTP를 사용해서 클라이언트와 서버가 데이터를 주고받는데, 여기서 주고받는 데이터가 들어가는 영역을 말한다.
  • HTTP Method POST, GET, PUT, PATCH, DELETE 이거만 확실히 알고 넘어가면 된다.
  • 상태코드 응답코드라고 보면 된다. HTTP로 API로 통신할 때 요청을 보내고 응답을 받을 때 상태 코드가 같이 날라온다. 앞자리 1개씩만 기억하면 된다.
    • 1xx (정보) 가장 안쓰이는게 1xx 상태코드
    • 2xx (성공) 요청한 API가 정상적으로 완료되었다.
    • 3xx (리다이렉션) 쇼핑몰에서 쇼핑하다가 마음에 드는 제품을 조회하다가 구매하기를 누르면 로그인 페이지 갔다가 다시 제품 화면으로 넘어가거나 결제 페이지로 넘어가는 경우
    • 4xx (클라이언트 에러) 회원가입을 할 때 특수문자를 반드시 포함해야하는데 하지 않는 경우. 클라이언트의 입력값이 잘못된 경우
    • 5xx (서버 에러) 클라이언트는 정상적으로 입력했으나 서버가 다운되었거나 일시적인 문제가 생기거나 로직이 잘못된 경우

Restful API HTTP를 기반으로 리소스(자원)을 URI로 표현하고, HTTP Method로 행위를 표현하는 API 설계 방식이다. - 뜬구름 잡는 소리

• URI 와 URL 은 비슷하지만 다르다. 포함 관계

• 리소스가 애매한 경우가 있는데 만약 우리가 게시물을 작성하는 API 를 HTTP 환경에서 요청했을 경우 서버는 게시물을 저장한다. 회원 가입의 경우 유저 데이터를 저장한다. 내가 무언가를 요청했을 때 서버에 저장되는 데이터를 리소스(자원) 이라고 한다.

• 만약 www.쇼핑몰.com/categories/1/products/2 해당 URL에 대해 설명하라고 한다면 어떻게 할 것인가?

  : 1번째 카테고리 2번째 상품을 보는 것? (명확하지 않음)

• API는 CRUD 로 이루어져 있다. 대표적으로 로그인은 예외 (애매하지만 POST 사용)

  • Create - POST
  • Read - GET
  • Update - PUT, PATCH
  • Delete - DELETE

  만약 {상품 = 이름, 가격, 수량} 이 있고 모두 수정한다면 PUT, 이름만 수정한다면 PATCH 를 사용한다.

• Restful API란 URL + HTTP Method만 보고도 어떤 역할을 수행하는 API인지 알 수 있어야 한다.

  • www.쇼핑몰.com/categories/1/products/2 + GET 1번 카테고리 2번 상품 가져오기
  • www.쇼핑몰.com/categories/1/products/2 + PUT 1번 카테고리 2번 상품 수정
  • www.쇼핑몰.com/categories/1/products/2 + DELETE 1번 카테고리 2번 상품 삭제
  • www.쇼핑몰.com/categories/1/products + POST 1번 카테고리 2번 상품 등록 product는 서버에서 관리하고 생성하기 전에는 상품 번호를 알 수 없기 때문에 다르다.

• Restful API 를 만들 때 URL 설계 규칙 (검색해보면 나온다)

  • 소문자만 써야 한다.
  • 슬래시(/)로 계층 구조를 표현해야 한다.
  • 단수가 아니라 복수형을 써야 한다.
  • 하이픈(-) 쓰면 안된다.
  • 동사를 쓰면 안된다. 어차피 API의 99퍼는 CRUD 이기 때문에 API명을 create-user로 만들 필요는 없다. www.naver.com/users + POST 이런 식으로 사용

JSON 하나의 규약이다. 어플리케이션이 어떤 것으로 만들었든 상관없이 편하게 통신하기 위해 만든 규약.

API 요청 예시 www.쇼핑몰.com/categories/2/products + POST HEADER application/json {"name": "바람막이", "price": 15000, "quantity": 5}

API 응답 예시 상태코드 2xx {"message": "당신이 지금 생성한 상품의 아이디는 2번입니다"}