如何让Python包用户无需知晓API URL即可访问API接口？

以下是几种实用的实现方式，能让用户无需知晓API的具体URL即可调用端点：

1. 内置基础URL到包核心模块 #

直接在包的内部代码中定义API基础URL常量，对外暴露的函数只接收端点路径，内部自动拼接完整地址。用户接触不到基础URL。

示例代码（包内的api_client.py）：

# 仅在包内部可见的基础URL
_BASE_API_URL = "https://your-proprietary-api.com/v1"

def call_api(endpoint, **kwargs):
    # 拼接完整请求地址
    full_url = f"{_BASE_API_URL}/{endpoint.lstrip('/')}"
    # 执行请求逻辑（以requests为例）
    import requests
    response = requests.get(full_url, **kwargs)
    response.raise_for_status()
    return response.json()

用户使用时只需传入端点：

from your_package import call_api

# 用户仅需指定API端点，无需关心基础URL
user_list = call_api("users/list", params={"page": 2})

2. 通过包内配置类管理URL #

在包内设置配置类，默认加载你的API地址，同时提供可选的修改入口（仅当用户需要自定义时才用到）。

示例：

# 包内的config.py
class APIClientConfig:
    def __init__(self):
        self.base_url = "https://your-proprietary-api.com/v1"

# 包内的api_client.py
from .config import APIClientConfig

# 初始化全局配置
_api_config = APIClientConfig()

def set_base_url(new_url):
    """可选：允许用户自定义API地址（一般无需使用）"""
    _api_config.base_url = new_url

def call_api(endpoint, **kwargs):
    full_url = f"{_api_config.base_url}/{endpoint.lstrip('/')}"
    # 请求逻辑...

用户正常使用时无需调用set_base_url，完全感知不到基础URL的存在。

3. 从环境变量加载URL（适合多环境切换） #

将基础URL默认值内置，同时支持通过环境变量覆盖。用户不需要手动设置环境变量时，就不会知道默认的API地址。

示例：

# 包内的api_client.py
import os

# 优先读取环境变量，不存在则用默认地址
_BASE_API_URL = os.getenv("YOUR_PACKAGE_API_URL", "https://your-proprietary-api.com/v1")

def call_api(endpoint, **kwargs):
    full_url = f"{_BASE_API_URL}/{endpoint.lstrip('/')}"
    # 请求逻辑...

补充注意事项 #

• 如果担心内置URL被反编译获取，可以将包打包成.whl格式发布，或使用代码混淆工具增加拆解难度（Python解释型语言无法完全隐藏，但能提高门槛）。
• API密钥等敏感信息不要内置，需让用户通过环境变量或参数传入，避免泄露风险。

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