📒 | IT지식- API와 JSON

비전공자를 위한 이해할 수 있는 IT 지식 - 4장. API와 JSON

 

1. API와 CRUD

API

• 사용하는 이유 : 컴퓨터는 한글을 모르기 때문에, 사람의 요청을 컴퓨터가 구분할 수 있도록 체계를 잡은 것
• 클라이언트, 서버와 같은 서로 다른 프로그램(소프트웨어)에서 요청과 응답을 주고 받을 수 있게 만든 체계
• 서로 다른 시스템의 기능을 사용할 수 있게 만든 체계
• 요청을 보내는 쪽과 응답을 주는 쪽이 나뉘어 있음

 

 

서버주소

• 서버 컴퓨터가 위치한 곳의 주소(IP) 서버 개발자가 만들고, 그 결과는 서버 프로그램이 된다.
• 즉 API는 서버 개발자가 개발하고 클라이언트 개발자는 그 API를 사용
• IP주소 : 000.000.000.000과 같은 숫자로 이루어짐
• 도메인 네임 : IP주소보다 더욱 이해하기 좋게 문자로 만든 것. ex. https://sini12.tistory.com/

 

 

 

 

API를 만들 때는 데이터를 주고 받는 기능도 함께 넣는다. 따라서 API를 통해 요청과 응답을 주고 받을 때는 데이터도 같이 담긴다.

데이터를 다룰 때 기준이 되는 요청, CRUD (블로그를 가정했을 때)

• Create : (Post 생성해줘)타임라인에 사진을 '올리는'요청
• Read : (Get 불러와줘)타임라인에 사진을 '불러오는'요청
• Update : (Put전체 / Patch일부 바꿔줘)타임라인에 사진을 '바꾸는'요청
• Delete : (Delete 지워줘)타임라인에 사진을 '지우는'요청

개발자들은 데이터를 볼 때 항상 CRUD의 관점에서 생각한다. 초보 기획자들은 쉽지 않기 때문에 '데이터를 볼 수는 있는데 만드는 기획은 없는'실수를 하기도 한다. 이런 실수를 방지하기 위해서는 CRUD관점에서 데이터를 바라봐야 한다. 만약 CRUD 중 특정 기능이 없는 기획이라면, 그 기획 의도가 명확해야 하며, 이유도 설명할 수 있어야 한다.

 

 

 

타임라인의 CRUD요청은 각각의 주소를 가지는데, 주소가 너무 많아지고 관리하기 힘들기 때문에 체계적인 API사회 운동인 만들어진다.

REST(Respresentational State Transfer)한 API 즉, RESTful API라고 한다.

위 (볼드체)스티커(메소드Method)를 사용

• 메소드 : '함수'와 같은의미. x라는 입력값에 따라서 y라는 결과가 나옴
• 변수, 파라미터 : x라는 입력값
  • ex. 로그인 요청에서 필요한 ID와 비밀번호 : 로그인 요청에 필요한 요청 변수 혹은 파라미터

 

 

HTTP 상태코드

컴퓨터가 보내는 응답은 2가지이다. "잘 됐어", "잘 안됐어"

• 2xx : 잘됐어

잘 안된 경우는 보통 클라이언트의 요청 때문에, 서버 내부적으로 안된 2가지의 경우가 있다.

• 4xx : 클라이언트의 요청에서 문제가 있는 경우
  • 404 에러 코드 : 정의되지 않은 요청을 보낼 때. 즉, 서버는 문제 없이 잘 돌아가고 있는데 요청이 이상
• 5xx : 서버에서 문제가 있는 경우

 

 

SDK(Software Development Kit)

다른 소프트웨어를 활용할 때, API를 제공해주는 '다른 소프트웨어'를 부르는 명칭

• ex. 내 소프트웨어에 구글 지도 SDK 설치 → 구글지도 SDK에서 제공해주는 API사용

 

 

OPEN API

서버가 제공하는 API문서로, 일반 사람들이 다양한 기능을 사용할 수 있게 열어둔 API

 

 

---

 

2. JSON

JSON : API에 데이터를 넣는 형식 중 하나

"그 정보는 JSON으로 보냈어요."
"로그인 API응답 보낼 때, JSON안에 같이 넣어서 보낼게요."
"그건 JSON에 들어있어요"

대화를 보면 마치 JSON을 데이터를 주고받는 주머니 처럼 여긴다. 클라와 서버는 요청과 응답을 주고받고, 그 때 필요한 데이터들을 JSON형식으로 주고받는다.

 

{
"id":"sini12",
"pw":"a12345"
}

• 형식 : 중괄호로 시작, 키(Key)와 값(Value)은 콜론(:)으로 구분
• 예시 : 로그인 요청에서 ID와 비밀번호

 

{
"category":"음료"
"sort":"desc",
"items":["카페모카","카페라떼","아메리카노"]
}

• 배열(Array) : []대괄호로 표시
  • 여러 정보가 필요할 때 사용