Pythonで、他の人が呼び出せるようにAPIをラップする方法

PythonではAPIのカプセル化は、クラスまたは関数を生成することで実現されます。

一般的な方法は、クラスを作成し、その中にメソッドやカプセル化する必要があるプロパティを定義します。ユーザはクラスをインスタンス化し、メソッドを呼び出して提供された機能を使用できます。例を示します。

class MyAPI:
    def __init__(self, api_key):
        self.api_key = api_key
    
    def get_data(self, param1, param2):
        # 这里是获取数据的具体逻辑
        # 可以使用self.api_key来进行身份验证等操作
        # 返回获取的数据
        return data


# 创建API实例
api = MyAPI(api_key='your_api_key')
# 调用API方法
result = api.get_data(param1='value1', param2='value2')

APIの機能をラップする関数を直接作成する方法もあります。この方法はより簡潔で、ステートを維持する必要のないAPIに適しています。以下に例を示します。

def get_data(api_key, param1, param2):
    # 这里是获取数据的具体逻辑
    # 可以使用api_key来进行身份验证等操作
    # 返回获取的数据
    return data


# 调用API函数
result = get_data(api_key='your_api_key', param1='value1', param2='value2')

APIをラップするときは、他者が利用する際に便利に理解できるように、インターフェース設計と引数の妥当性についてはクラスと関数のどちらを用いる場合も検討する必要がある。