Python API

Python API Start

BioinformaticsAndMe

#API 기초 학습을 위해 아래 포스트 참조

https://bioinformaticsandme.tistory.com/135

Python API

: 파이썬에서 API 작업을 하기 위해, 'requests' 라이브러리 사용

1. Making API Requests in Python

'requests'는 파이썬 표준 라이브러리가 아니므로, 아래 두 가지 경로 중 하나로 설치 필요

#pip 설치
pip install requests

#conda 설치
conda install requests

라이브러리가 설치되면, 'requests'를 import 하기

import requests

2. Making Our First API Request

request에는 다양한 형태가 존재

*GET: 데이터 검색

*POST: 새로운 데이터를 서버에 추가

*PUT: 기존 정보 변경

*DELETE: 기존 정보 삭제

request를 실행할 때, API 서버로부터 response data와 response code를 받음

response code는 우리의 request가 성공적인지 말해줌 (!문제가 있다면 원인을 설명)

'GET’ request를 실행하기 위해, requests.get() function을 사용함

requests.get() function은 사용자가 request를 진행하고 싶은 URL을 입력값으로 사용

http://open-notify.org/ 를 API server 로 두고 연습 진행

#request를 만들고 결과값을 출력
request = requests.get('http://api.open-notify.org')
print(request.text)

#response code 확인 (200 : request가 성공적으로 작동)
print(request.status_code)
200

request된 URL이 서버에서 발견되지 않는다면 404 에러 출력

request2 = requests.get('http://api.open-notify.org/fake-endpoint')
print(request2.status_code)
404

3. API Status Codes

API Status codes는 서버 request 요청에 대한 상태 출력

200 – OK. The request was successful.

   The answer itself depends on the method used (GET, POST, etc.) and the API specification.

204 – No Content.

        The server successfully processed the request and did not return any content.

301 – Moved Permanently.

        The server responds that the requested page (endpoint) has been moved to another address and redirects to this address.

400 – Bad Request.

        The server cannot process the request because the client-side errors (incorrect request format).

401 – Unauthorized.

        Occurs when authentication was failed, due to incorrect credentials or even their absence.

403 – Forbidden.

        Access to the specified resource is denied.

404 – Not Found.

        The requested resource was not found on the server.

500 – Internal Server Error.

        Occurs when an unknown error has occurred on the server.

#Reference

1) https://www.dataquest.io/blog/python-api-tutorial/

2) https://medium.com/quick-code/absolute-beginners-guide-to-slaying-apis-using-python-7b380dc82236

3) https://blog.rapidapi.com/how-to-use-an-api-with-python/

4) https://itnext.io/api-calls-and-http-status-codes-e0240f78f585

Python API End

BioinformaticsAndMe