postman 으로 openAPI 데이터 조회하기
부트캠프에서 postman 툴을 사용하는 법을 배워 관련 내용을 포스팅해보려 한다.
Postman
- API 개발을 보다 빠르고 쉽게 구현 할 수 있도록 도와주며, 개발된 API를 테스트하여 문서화 또는 공유 할 수 있도록 도와 주는 플랫폼
- 직접 개발한 API 또는 타 API를 테스트할 때 개발 환경보다 빠르게 이용할 수 있다.
Postman으로 openAPI의 데이터 조회하기
postman으로 api의 데이터를 조회하려면 다음과 같은 과정을 진행한다.
- postman 회원가입
- postman workspace 생성
- open API 사이트 회원가입
- open API 사이트에서 조회하고 싶은 데이터 선택 및 API키 발급
- postman에서 openAPI 데이터 조회하기
1. postman 회원가입
화면 우측 상단에 있는 Sign Up for Free 버튼을 통해 회원가입을 진행한다.
구글 계정이 있다면 해당 계정으로 간편하게 가입을 진행할 수 있다.
2. postman workspace 생성
API를 테스트할 workspace를 생성한다.
3. open API 사이트 회원가입
- 사이트 : 공공데이터포털 ( https://www.data.go.kr/index.do )
4. open API 사이트에서 조회하고 싶은 데이터 선택 및 API키 발급
1) 내가 사용하려는 데이터에 대해 승인을 받는 절차를 진행한다.
2) 내가 사용하려는 데이터에 대한 인증키를 발급받은 후 데이터를 활용하기 위한 설정을 진행한다.
위의 캡쳐에 보이는 [승인] 서울특별시 용산구_실외운동기구현황 링크에 접근 후
다음 캡쳐를 통해 해당 링크에 잘 접근했는지 확인한다.
해당 화면에서 아래 방향으로 스크롤 시 인증키 두 개가 있는 것을 확인할 수 있다.
캡처에서 인증키를 가려놓은 이유는 인증키가 외부 노출 시 악의적으로 사용될 수 있기 때문이다.
이 글을 보는 분들도 API의 인증키에 다룰 때는 노출이 되지 않게 주의를 바란다.
인증키 두 개는 다음 단계에서 사용할 것이므로 따로 메모장에 복사한다.
API를 활용하기 위해 인증키 설정을 하는 단계이다.
우측 하단의 초록색 글자로 표시된 인증키 설정 버튼을 클릭한다.
인증키 입력 후 설정 버튼을 누르면 아래와 같은 화면을 확인할 수 있다.
3) Request URL 생성
생성된 Request URL을 복사 후 postman 사이트로 이동한다.
5. postman에서 openAPI 데이터 조회하기
데이터 조회 성공 시 아래와 같이 상태코드 200 OK와 함께 데이터들을 확인할 수 있다.
참고 사이트
- https://incheol-jung.gitbook.io/docs/q-and-a/infra/2018-01-03-how-to-use-postman