如何将普通Python API请求代码转换为Python函数

把顺序执行的脚本改写为可复用函数，只需要3个核心步骤：

• 用def关键字定义函数，把接口地址、API密钥、待提交文本这类需要动态修改的值设置为函数入参，避免硬编码
• 把原有的请求发送逻辑放到函数代码块内部
• 把原代码直接打印结果的逻辑改为函数返回值，方便不同场景调用时拿到结果做后续处理

基础可运行改写版本 #

import requests
import json

def send_text_api_request(api_url: str, api_key: str, text_content: str) -> str:
    """
    提交文本到指定API接口
    :param api_url: 目标API的请求地址
    :param api_key: 接口鉴权用的API密钥
    :param text_content: 要提交的文本内容
    :return: 接口返回的响应文本
    """
    response = requests.post(
        api_url,
        data={"text": text_content},
        headers={"api-key": api_key}
    )
    return response.text

# 函数调用示例
if __name__ == "__main__":
    api_resp = send_text_api_request(
        api_url="https://api.xxxxxxxx",
        api_key="MY_SECRET_API_KEY",
        text_content="i won the match"
    )
    print(api_resp)

实用优化点 #

• 密钥安全：实际使用时不要把API密钥硬编码在代码中，建议从环境变量或独立配置文件读取，防止密钥意外泄露
• 可按需增加异常捕获逻辑，处理请求超时、接口返回错误状态码、网络中断等异常情况，提升代码鲁棒性
• 如果接口要求接收JSON格式参数，把请求入参的data=替换为json=即可，requests会自动完成参数序列化，不需要手动调用json.dumps

内容的提问来源于stack exchange，提问作者sonu