[ postman ] api호출해보기

업무를 하다보면..

(1) 로그를 봐야할 경우가 갱장히 완전히 많이 생긴다.

그래서 개발자 도구/elk 로그를 활용을 하는데,show만 될 뿐 update를 칠 수가 없다.

 

(2) 개발자에게 일일히 봐달라 하기가 곤란한 상황이 생긴다.

그래서 개발자 도구를 활용을 하는데, 얘는 update를 칠 수가 없다.

 

그래서 사용하게 된 것이 postman 

 

 

POSTMAN이 뭐야?!

편리하게 api 개발을 할 수 있게 해주고 개발된 api를 문서화, 공유화 하게 함 

REST API를 표현함 = URL로 제어할 것을 명명하고 HTTP를 통해 제어를 실현

 

---

 

사실 비개발자가 알고 있으면 되는 기능은 아래 두개면 된다.

 

1. 변수 사용

정해둔 변수 부분은 기입의 귀찮음을 해소해줌 (일괄 기능)

 

희미한 선으로 구분된 것이 보이는가?

globals : 전역변수=어떤 환경에서도 접근 가능 (함수의 외부에서 선언된 변수) , 1순위

선 밑 직접 설정한 환경 : 지역 변수= 특정 지정 환경에서만 접근 가능

 

2. Collections 사용

필요시 재사용이 편하도록 묶어둔 형태

 

---

 

각 기능을 찢어서 확인해보자

그 전에 알아야 하는 용어부터 소개한다.

 

쿼리

- 데이터 베이스에 정보 요청을 문의하고자 작성하는 명령어 

- 접근법 : 매개변수 목록 제시 / 예제 작성으로 접근(QBE) / SQL 언어 사용

   => 우리가 POSTMAN에서 선택하는건 매개변수 목록 제시

 

- 웹은 데이터를 불러올 때, GET METHOD를 사용하여 URL 끝단에 쿼리 매개변수를 문자열로 포함함

EX) http://127.0.0.1:8000/items/?skip=0&limit=10   (쿼리의 매개변수 = skip: 값 0 , limit: 값10)

 

- 매개변수는 고정값이 아니지만 기본값이 존재하고, 선택도 가능함

EX) http://127.0.0.1:8000/items/ = http://127.0.0.1:8000/items/?skip=0&limit=10 (쿼리의 매개변수 = skip: 값 0 , limit: 값10)

       http://127.0.0.1:8000/items/?skip=20  (쿼리의 매개변수 = skip: 값 20 , limit: 값10)

      http://127.0.0.1:8000/items/?limit=20 (쿼리의 매개변수 = skip: 값 10 , limit: 값 20)

 

요청 매개 변수 표현방식 : 쿼리 q와 QA

- 앞에 ? 들어감

- 매개변수가 여러개인 경우 &로 연결됨

- 구조는  KEY=VALUE

 

- q : 쿼리를 나타내는 키 

- QA : 쿼리 키, 검색어 값

EX) ~ search?q=강아지&rlz=1C~~ ( KEY q 와 VALUE 강아지, &로 연결하여  KEY rlz 와 VALUE 1C~)

* rlz는 라이브러리

 

 

1. params

서버에서 추가 데이터를 보내는 역할

URL을 이해하면 편함 

 

(1) 데이터를 불러오려 할 때 - 매개변수 1개

- METHOD : GET

- PARAMS : KEY q  /  value 강아지

검정박스를 체크해야 URL 자동 입력됨

 

(2) 데이터를 불러오려 할 때 - 매개변수 N개

- METHOD : GET

- PARAMS : KEY q  /  VALUE 강아지 & KEY rlz VALUE 1C1GCEU_koKR1021KR1027 & KEY aqs / VALUE & chrome..69i57j69i59.1201j0j7 & KEY ie / VALUE UTF-8

 

 

2. Authorization

- API 사용 가능한 권한이 있는지 확인하는 인증시스템

- Bearer Token 

 

- API Key 

우리회사는 Baerer Token을 사용함

 

 

3. Header 와 Body

- JSON 형식으로 입력한다.

- Authorization 입력이 귀찮으면 Header에 key-value 저장해서 사용도 가능(콜렉션화를 더 추천하긴 함)

- GET METHOD는 따로 입력할 필요가 없다.

- POST METHOD는 다음과 같이 입력한다.

• Header key: Content-Type, Value: application/json / Body raw 선택하고 json 파라미터 입력
• Header key: Content-Type, Value: x-www-form-urlencoded / Body  x-www-form-urlencoded  선택하고 key,value 맞게입력

 

 

(+) 다양한 연습이 필요할 경우, 공공 포털 API를 활용해 연습해보면 된다

상세 설명은 아래 URL 참고 https://jung-story.tistory.com/135

검색 조건 팁!

 

 

 

 

출처 :

https://velog.io/@shawnhansh/Postman-Authorization에-토큰-추가하기

https://incheol-jung.gitbook.io/docs/q-and-a/infra/2018-01-03-how-to-use-postman

https://fastapi.tiangolo.com/ko/tutorial/query-params/ 

https://testmanager.tistory.com/340 

https://nocount.tistory.com/117