FastAPI 学习之路（二十）接口文档配置相关
FastAPI 系列文章：
FastAPI 学习之路（四）使用pydantic模型做请求体
FastAPI 学习之路（十三）Cookie 参数,Header参数
前言
我们之前分享的处理错误。这次我们看下一些配置
正文
我们都知道，fastApi给我们提供了接口文档，在我们的实际开发中，我们会有很多的接口，有些接口需要分组，比如我们对于登录注册相关的模块，可以统一放在登录，那么我们如何实现划分呢。
from fastapi import FastAPI
app = FastAPI()
@app.post("/login/", tags=["login"])
def login(username: str,password:str):
if username == "leizi" and password=="123":
return "success"
return {"name": username}
@app.post("/regin/", tags=["login"])
def regin(username: str,password:str):
return {"name": username}我们看下，接口文档
可以看到，我们实现的登录的模块是成功的。
我们来看下，如何对接口增加一个简单的描述
from fastapi import FastAPI
app = FastAPI()
@app.post("/login/", tags=["login"],description="这是登录模块")
def login(username: str,password:str):
if username == "leizi" and password=="123":
return "success"
return {"name": username}
@app.post("/regin/", tags=["login"])
def regin(username: str,password:str):
return {"name": username}我们看下接口
如果我们想要把所有的注释以给读取出来，然后展示在描述中，fastapi也给我们做了很好的封装，我们可以简单的看下代码
from fastapi import FastAPI
app = FastAPI()
@app.post("/login/", tags=["login"],summary="这是登录模块")
def login(username: str,password:str):
"""
登录
- param username: 用户名
- param password: 密码
- return: 返回是否成功
"""
if username == "leizi" and password=="123":
return "success"
return {"name": username}
@app.post("/regin/", tags=["login"])
def regin(username: str,password:str):
return {"name": username}我们看下最后的实现的效果
如果我们要标注接口启用怎么实现呢
from fastapi import FastAPI
app = FastAPI()
@app.post("/login/", tags=["login"],summary="这是登录模块")
def login(username: str,password:str):
"""
登录
- param username: 用户名
- param password: 密码
- return: 返回是否成功
"""
if username == "leizi" and password=="123":
return "success"
return {"name": username}
@app.post("/regin/", tags=["login"],deprecated=True)
def regin(username: str,password:str):
return {"name": username}我们可以接口文档的展示
后记
发现问题，解决问题。遇到问题，慢慢解决问题即可。
欢迎关注雷子说测试开发，后续将会持续为大家分享更多的技术知识
如果你有问题可以留言或者加我微信:952943386。2021，一起牛转钱坤，一起牛逼。
如果觉得这篇文章还不错，来个【分享、点赞、在看】三连吧，让更多的人也看到~
本文参与 腾讯云自媒体同步曝光计划，分享自微信公众号。
原始发表：2021-08-14，如有侵权请联系 cloudcommunity@tencent.com 删除
评论
登录后参与评论
推荐阅读
目录
腾讯云开发者
