python接口文档示例

以下是一个简单的Python接口文档示例：

"""
My API
This is my awesome API
"""

def get_user(username):
    """
    Retrieve information about a user

    :param username: The username of the user to retrieve
    :type username: str
    :return: A dictionary containing information about the user
    :rtype: dict
    """
    # Code to retrieve user information
    return {"username": username, "age": 30, "location": "San Francisco"}

def create_user(username, age, location):
    """
    Create a new user

    :param username: The username of the new user
    :type username: str
    :param age: The age of the new user
    :type age: int
    :param location: The location of the new user
    :type location: str
    :return: A dictionary containing information about the new user
    :rtype: dict
    """
    # Code to create a new user
    return {"username": username, "age": age, "location": location}

在这个示例中，我们定义了两个函数：`get_user` 和 `create_user`。每个函数都有一个 docstring，其中包含有关该函数的描述、参数和返回值的详细信息。这些 docstring 可以被文档生成工具（如 Sphinx）用于生成 HTML、PDF 等格式的文档。