如果API服务的路径参数或查询参数不是必须要求传递的，可以设置为 optional（可选的）。要声明一个可选参数，我们需要从类型模块（typing module）导入Optional类型，然后使用它来设置参数。它应该使用括号[] 包装参数的假定数据类型，如果需要，可以有任何默认值。

本文将使用FastAPI框架，创建两个服务，其中使用到可选参数。

一、可选参数示例代码

如下是unlock_username()和unlock_password() 服务的示例代码：

from typing import Optional, List, Dict

@app.post("/ch01/login/username/unlock")
def unlock_username(id: Optional[UUID] = None):
 if id is None:
 return {"message": "需要传入id"}
 else:
 for key, val in valid_users.items():
 if val.id == id:
 return {"username": val.username}
 return {"message": "用户不存在"}

上述方法接收一个可选的UUID类型的参数 id。如果没有提供 id（即 id 是 None），它将返回一条消息提示需要传入 id。如果提供了 id，它将遍历 valid_users 字典（假设是一个全局变量，其中包含有效用户的数据）。

@app.post("/ch01/login/password/unlock")
def unlock_password(username: Optional[str] = None, id: Optional[UUID] = None):
 if username is None:
 return {"message": "必须传入username"}
 elif valid_users.get(username) is None:
 return {"message": "用户不存在"}
 else:
 if id is None:
 return {"message": "需要传入id"}
 else:
 user = valid_users.get(username)
 if user.id == id:
 return {"password": user.password}
 else:
 return {"message": "id无效"}

上述代码接受两个可选参数：username（字符串类型）和 id（UUID 类型）。

如果没有提供 username，它将返回一条消息提示必须传入 username。

如果提供了 username，但它不在 valid_users 字典中，将返回一条消息提示用户不存在。

如果用户存在但没有提供 id，它将返回一条消息提示需要传入 id。

如果用户存在且提供了 id，它将比较提供的 id 和用户的 id。

二、启动应用

在命令行执行如下命令：

uvicorn main:app --reload

该命令将通过 main.py 文件和FastAPI 对象引用将应用程序加载到 uvicorn 实时服务器。

POST请求：localhost:8000/ch01/login/username/unlock，不传入id 参数，如图所示：

传入可以匹配的id参数，返回对应的username，如图所示：

POST请求：localhost:8000/ch01/login/password/unlock

在没有传入username、id参数时，参数合法性校验无法通过。

前面的unlock_username() 和unlock_password() 服务将其所有参数声明为可选的（optional parameters）。在处理这些类型的参数时，不要忘记在实现中应用异常处理或防御性验证，以避免HTTP Status 500（内部服务器错误）。

另外，FastAPI框架还支持混合所有类型的参数，但是在使用时需要谨慎。

对于混合参数类型，应该首先声明所有必需的参数，然后是默认参数，最后在参数列表中应该是可选类型。忽略此排序规则将生成编译器错误。

#冬日生活打卡季##fastapi#