如何调用api接口python

要调用API接口，可以使用Python的requests库、http.client库、urllib库等工具。requests库、http.client库、urllib库是常用的方法。下面将详细介绍如何使用requests库调用API接口。

一、安装requests库

首先，需要安装requests库。可以通过pip命令来安装：

pip install requests

二、使用requests库调用API

1、GET请求

GET请求通常用于从服务器获取数据。以下是一个示例：

import requests
url = "https://api.example.com/data"
params = {
    "key1": "value1",
    "key2": "value2"
}
response = requests.get(url, params=params)
检查请求是否成功
if response.status_code == 200:
    data = response.json()  # 解析返回的JSON数据
    print(data)
else:
    print(f"请求失败，状态码：{response.status_code}")

在这个示例中，我们使用requests.get()方法发送GET请求，并通过params参数传递查询参数。如果请求成功，响应状态码为200，我们使用response.json()方法解析返回的JSON数据。

2、POST请求

POST请求通常用于向服务器发送数据。以下是一个示例：

import requests
url = "https://api.example.com/submit"
payload = {
    "key1": "value1",
    "key2": "value2"
}
response = requests.post(url, json=payload)
检查请求是否成功
if response.status_code == 200:
    data = response.json()  # 解析返回的JSON数据
    print(data)
else:
    print(f"请求失败，状态码：{response.status_code}")

在这个示例中，我们使用requests.post()方法发送POST请求，并通过json参数传递数据。如果请求成功，响应状态码为200，我们使用response.json()方法解析返回的JSON数据。

3、PUT请求

PUT请求通常用于更新服务器上的资源。以下是一个示例：

import requests
url = "https://api.example.com/update"
payload = {
    "key1": "new_value1",
    "key2": "new_value2"
}
response = requests.put(url, json=payload)
检查请求是否成功
if response.status_code == 200:
    data = response.json()  # 解析返回的JSON数据
    print(data)
else:
    print(f"请求失败，状态码：{response.status_code}")

在这个示例中，我们使用requests.put()方法发送PUT请求，并通过json参数传递更新的数据。如果请求成功，响应状态码为200，我们使用response.json()方法解析返回的JSON数据。

4、DELETE请求

DELETE请求通常用于删除服务器上的资源。以下是一个示例：

import requests
url = "https://api.example.com/delete"
params = {
    "id": "12345"
}
response = requests.delete(url, params=params)
检查请求是否成功
if response.status_code == 200:
    print("删除成功")
else:
    print(f"请求失败，状态码：{response.status_code}")

在这个示例中，我们使用requests.delete()方法发送DELETE请求，并通过params参数传递要删除资源的标识符。如果请求成功，响应状态码为200，我们输出“删除成功”。

三、处理API响应

1、解析JSON响应

大多数API返回的响应数据是JSON格式的，可以使用response.json()方法将其解析为Python字典：

data = response.json()

2、处理响应状态码

检查响应状态码，以确定请求是否成功。常见的状态码包括：

200：请求成功
201：资源创建成功
400：请求无效
401：未授权
403：禁止访问
404：未找到资源
500：服务器内部错误

可以使用response.status_code属性获取响应状态码：

if response.status_code == 200:
    print("请求成功")
else:
    print(f"请求失败，状态码：{response.status_code}")

3、处理响应头

可以使用response.headers属性获取响应头，这是一个字典类型的数据结构：

headers = response.headers

可以通过键名访问特定的响应头，例如获取内容类型：

content_type = headers.get("Content-Type")

四、异常处理

在调用API时可能会遇到异常情况，如网络错误、超时等。可以使用try-except语句进行异常处理：

import requests
url = "https://api.example.com/data"
try:
    response = requests.get(url)
    response.raise_for_status()  # 如果响应状态码不是200，会引发HTTPError异常
    data = response.json()
    print(data)
except requests.exceptions.RequestException as e:
    print(f"请求失败：{e}")

在这个示例中，我们使用response.raise_for_status()方法检查响应状态码，如果不是200，会引发HTTPError异常。我们还可以捕获其他类型的异常，如requests.exceptions.ConnectionError、requests.exceptions.Timeout等。

五、添加请求头

有些API需要添加请求头才能正常访问，例如身份验证。可以使用headers参数添加请求头：

import requests
url = "https://api.example.com/data"
headers = {
    "Authorization": "Bearer YOUR_ACCESS_TOKEN",
    "Accept": "application/json"
}
response = requests.get(url, headers=headers)
检查请求是否成功
if response.status_code == 200:
    data = response.json()  # 解析返回的JSON数据
    print(data)
else:
    print(f"请求失败，状态码：{response.status_code}")

在这个示例中，我们通过headers参数添加了Authorization和Accept请求头。

六、处理分页响应

有些API返回的数据是分页的，需要通过多个请求获取所有数据。通常可以通过响应中的链接或参数来处理分页。例如：

import requests
url = "https://api.example.com/data"
params = {
    "page": 1,
    "per_page": 100
}
all_data = []
while True:
    response = requests.get(url, params=params)
    if response.status_code == 200:
        data = response.json()
        all_data.extend(data["items"])
        if "next" in data["links"]:
            params["page"] += 1
        else:
            break
    else:
        print(f"请求失败，状态码：{response.status_code}")
        break
print(all_data)

在这个示例中，我们通过params参数传递分页参数page和per_page，并通过循环发送请求，直到没有下一页。

七、使用Session保持会话

在某些情况下，需要在多个请求之间保持会话，例如保持登录状态。可以使用requests.Session对象：

import requests
session = requests.Session()
登录请求
login_url = "https://api.example.com/login"
login_payload = {
    "username": "your_username",
    "password": "your_password"
}
session.post(login_url, json=login_payload)
后续请求
data_url = "https://api.example.com/data"
response = session.get(data_url)
检查请求是否成功
if response.status_code == 200:
    data = response.json()  # 解析返回的JSON数据
    print(data)
else:
    print(f"请求失败，状态码：{response.status_code}")

在这个示例中，我们使用requests.Session对象保持会话状态，首先发送登录请求，然后发送后续请求。

八、处理文件上传和下载

1、文件上传

可以通过POST请求上传文件，使用files参数传递文件：

import requests
url = "https://api.example.com/upload"
file_path = "/path/to/your/file.txt"
files = {
    "file": open(file_path, "rb")
}
response = requests.post(url, files=files)
检查请求是否成功
if response.status_code == 200:
    print("文件上传成功")
else:
    print(f"请求失败，状态码：{response.status_code}")

在这个示例中，我们使用requests.post()方法发送POST请求，并通过files参数上传文件。

2、文件下载

可以通过GET请求下载文件，并将其保存到本地：

import requests
url = "https://api.example.com/download"
response = requests.get(url)
检查请求是否成功
if response.status_code == 200:
    with open("/path/to/save/file.txt", "wb") as file:
        file.write(response.content)
    print("文件下载成功")
else:
    print(f"请求失败，状态码：{response.status_code}")

在这个示例中，我们使用requests.get()方法发送GET请求，并通过response.content获取文件内容，然后将其保存到本地文件。

九、处理重定向

有些API会返回重定向响应，可以通过allow_redirects参数控制是否自动处理重定向：

import requests
url = "https://api.example.com/redirect"
response = requests.get(url, allow_redirects=False)
检查请求是否成功
if response.status_code == 302:  # 重定向状态码
    redirect_url = response.headers.get("Location")
    print(f"重定向到：{redirect_url}")
else:
    print(f"请求失败，状态码：{response.status_code}")

在这个示例中，我们通过allow_redirects=False参数禁用自动重定向处理，并手动处理重定向响应。

十、设置请求超时

为了防止请求长时间挂起，可以设置请求超时：

import requests
url = "https://api.example.com/data"
try:
    response = requests.get(url, timeout=5)  # 设置超时时间为5秒
    if response.status_code == 200:
        data = response.json()  # 解析返回的JSON数据
        print(data)
    else:
        print(f"请求失败，状态码：{response.status_code}")
except requests.exceptions.Timeout:
    print("请求超时")

在这个示例中，我们通过timeout参数设置请求超时时间为5秒。

总结

通过以上内容，我们详细介绍了如何使用Python调用API接口。我们从安装requests库、发送GET、POST、PUT、DELETE请求，到处理API响应、异常处理、添加请求头、处理分页响应、使用Session保持会话、处理文件上传和下载、处理重定向和设置请求超时等方面进行了全面讲解。通过这些示例，相信您已经掌握了如何使用Python调用API接口的基本方法和技巧。在实际应用中，可以根据具体需求灵活运用这些方法，以实现与API的交互。