API-method可以返回不同的类型，如何定义返回类型？

在软件开发中，API（应用程序编程接口）的方法通常需要定义其返回类型，以确保调用者能够正确处理返回的数据。以下是一些常见的方法来定义API方法的返回类型：

1. 使用编程语言的内置类型系统

大多数现代编程语言都提供了丰富的内置类型系统，可以直接用于定义API方法的返回类型。

示例（Python）：

from typing import Union

def get_user_info(user_id: int) -> Union[dict, None]:
    # 模拟获取用户信息
    if user_id == 1:
        return {"name": "Alice", "age": 30}
    else:
        return None

在这个例子中，get_user_info 方法可以返回一个字典（包含用户信息）或 None。

示例（Java）：

import java.util.Optional;

public class UserService {
    public Optional<User> getUserInfo(int userId) {
        // 模拟获取用户信息
        if (userId == 1) {
            return Optional.of(new User("Alice", 30));
        } else {
            return Optional.empty();
        }
    }
}

class User {
    private String name;
    private int age;

    public User(String name, int age) {
        this.name = name;
        this.age = age;
    }

    // Getters and setters
}

在这个例子中，getUserInfo 方法返回一个 Optional<User>，表示可能包含一个 User 对象或不包含任何对象。

2. 使用自定义数据类型

有时，API需要返回更复杂的数据结构，这时可以定义自定义的数据类型。

示例（TypeScript）：

interface User {
    name: string;
    age: number;
}

function getUserInfo(userId: number): User | null {
    // 模拟获取用户信息
    if (userId == 1) {
        return { name: "Alice", age: 30 };
    } else {
        return null;
    }
}

在这个例子中，getUserInfo 方法返回一个 User 对象或 null。

3. 使用枚举类型

如果API方法的返回值是有限的几种可能性之一，可以使用枚举类型来定义。

示例（C#）：

public enum UserStatus
{
    Active,
    Inactive,
    Suspended
}

public class UserService
{
    public UserStatus GetUserStatus(int userId)
    {
        // 模拟获取用户状态
        if (userId == 1)
        {
            return UserStatus.Active;
        }
        else if (userId == 2)
        {
            return UserStatus.Inactive;
        }
        else
        {
            return UserStatus.Suspended;
        }
    }
}

在这个例子中，GetUserStatus 方法返回一个 UserStatus 枚举值。