前言
上一篇我们分享了FastAPI 学习之路（四十二）利用Docker部署发布，这次我们分享下路径的高级配置。
正文
在实际的开发中呢，我们可能有些接口呢，不能对比进行开放，比如说我们内部的一些监控的接口，那么我们肯定想着如何在接口文档中进行屏蔽，那么我们看下应该如何实现呢。
代码语言：javascript复制@app.get("/legacy/", include_in_schema=False)
def get_legacy_data(response: Response):
headers = {"X-Cat": "leizi", "Content-Language": "en-US"}
data = """<?xml version="1.0"?>
<shampoo>
<Header>
Apply shampoo here.
</Header>
<Body>
You'll have to use soap here.
</Body>r
</shampoo>
"""
response.set_cookie(key="message", value="hello")
return Response(content=data, media_type="application/xml",
headers=headers)其实很简单，只需要配置
代码语言：javascript复制include_in_schema=False即可。那么我们看下接口文档是否有这个接口呢
是没有在接口的文档中展示的，只能供我们自己内部直接调用。我们直接去访问。
接口可以正常返回的。
docstring 的高级描述
路径操作函数 的 docstring 中用于 OpenAPI 的行数。
添加一个 f （一个「换页」的转义字符）可以使 FastAPI 在那一位置截断用于 OpenAPI 的输出。
我们看下在接口中的具体实现
代码语言：javascript复制# 新建用户
@usersRouter.post("/users/", tags=["users"], response_model=Users)
def create_user(user: UserCreate, db: Session = Depends(get_db)):
"""
- **email**: 用户的邮箱
- **password**: 用户密码
"""
db_crest = get_user_emai(db, user.email)
if not db_crest:
return db_create_user(db=db, user=user)
raise HTTPException(status_code=200, detail="账号不能重复")我们看下最后会返回什么。
我们可以看到，在接口文档中，我们去描述了我们的参数。文档内正常展示了，那么我们可以用这个，对接口的参数进行一些描述后，就可以展示在我们对外的接口文档中，方便去理解每个字段。
后记
发现问题，解决问题。遇到问题，慢慢解决问题即可。
欢迎关注雷子说测试开发，后续将会持续为大家分享更多的技术知识
