Python与REST API实战指南：网络开发者快速上手

在现代网络开发中，与 REST API 的交互是必备技能。尤其是准备参加 Cisco DevNet Associate 考试的开发者，掌握如何通过Python脚本访问和操作API，将大幅提升自动化能力和网络管理效率。本文将通过实用示例，指导你快速上手。

一. 安装与导入requests库

在开始之前，请确保已安装 requests 库：

pip install requests

在Python脚本中导入该库：

import requests

二. 定义API端点

调用REST API前，需要明确目标端点URL：

url = 'https://api.example.com/data'

三. 发起API请求

requests库提供多种方法轻松发起HTTP请求。

GET请求

response = requests.get(url)

POST请求

发送数据负载时使用POST请求：

payload = {'key1': 'value1', 'key2': 'value2'}
response = requests.post(url, data=payload)

四. 处理API响应

获取响应后，可将其转换为Python字典便于处理：

data = response.json()
print(data)

五. 示例：获取用户数据

以下示例通过用户ID从API获取数据，并检查HTTP响应状态：

import requests

def fetch_user_data(user_id):
    url = f'https://api.example.com/users/{user_id}'
    response = requests.get(url)

    if response.status_code == 200:
        return response.json()
    else:
        return f'Error: {response.status_code}'

# 示例用法
user_data = fetch_user_data(123)
print(user_data)

六. 配置网络设备

通过REST API更新网络设备配置，例如修改主机名：

import requests
import json

def update_hostname(device_ip, new_hostname, auth_token):
    url = f'http://{device_ip}/api/v1/configuration'
    headers = {
        'Content-Type': 'application/json',
        'Authorization': f'Bearer {auth_token}'
    }
    payload = {
        'hostname': new_hostname
    }

    response = requests.post(url, headers=headers, data=json.dumps(payload))

    if response.status_code == 200:
        print("Successfully updated the hostname.")
    else:
        print(f"Failed to update hostname. Status Code: {response.status_code}")

# 示例用法
device_ip = '192.168.1.100'
new_hostname = 'NewRouterName'
auth_token = 'your_auth_token_here'

update_hostname(device_ip, new_hostname, auth_token)

说明：

• update_hostname函数接收设备IP、新主机名和身份验证令牌。
• 使用POST请求发送JSON数据，并包含授权头。
• 根据响应状态判断操作是否成功。

七. 向网络设备发送JSON-RPC命令

通过JSON-RPC API获取设备状态示例：

import json
import requests

def get_switch_status(switch_ip, rpc_url, rpc_method):
    headers = {'Content-Type': 'application/json'}
    payload = {
        "jsonrpc": "2.0",
        "method": rpc_method,
        "params": [],
        "id": 1
    }

    response = requests.post(f'http://{switch_ip}/{rpc_url}', headers=headers, data=json.dumps(payload))

    if response.status_code == 200:
        return response.json()
    else:
        return f"Error: {response.status_code}"

# 示例用法
switch_ip = '192.168.1.50'
rpc_url = 'rpc'
rpc_method = 'getSwitchStatus'

status = get_switch_status(switch_ip, rpc_url, rpc_method)
print(status)

说明：

• 构造JSON有效载荷包含方法名和请求ID。
• 检查响应状态码并返回结果。

八. 总结

通过本文示例，你已经掌握了：

1. 使用Python requests库发起GET/POST请求。
2. 处理REST API响应并将其转换为Python数据结构。
3. 配置网络设备并通过API更新参数。
4. 发送JSON-RPC命令获取设备状态。

这些技能是现代网络开发和自动化的基础，对于网络工程师、开发者以及Cisco DevNet考生而言至关重要。

原文链接: https://jiminbyun.medium.com/building-python-scripts-for-rest-api-calls-a-practical-guide-2-9-3ac9ca1d701a