FastAPI 学习之路(二十)接口文档配置相关
2023-03-15 22:52:10 时间
系列文章:
FastAPI 学习之路(一)fastapi--高性能web开发框架
FastAPI 学习之路(十二)接口几个额外信息和额外数据类型
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}
我们可以接口文档的展示
文章首发在公众号,欢迎关注。
相关文章
- 一篇运维老司机的大数据平台监控宝典(2)-联通大数据集群平台监控体系详解
- 一篇运维老司机的大数据平台监控宝典(1)-联通大数据集群平台监控体系进程详解
- 空中换引擎 博时基金数字化转型经验谈
- 如何高效地学习编程语言
- 作为一名阿里巴巴数据分析大牛,送给学弟学妹的经验积分
- 为什么要学习R语言
- Hadoop大数据分析平台的介绍性讨论
- 最全面的Spring学习笔记
- 16个用于数据科学和机器学习的顶级平台
- 给有抱负的数据科学家的六条建议
- 如何做一枚合格的数据产品经理
- 除Kaggle外,还有哪些顶级数据科学竞赛平台
- 一个鲜为人知却可以保护隐私的训练方法:联合学习
- 干货 :送你12个关于数据科学学习的关键提示(附链接)
- 大数据行业有多少种工作岗位,各自的技能需求是什么?
- 中国移动研究院常耀斌:商用大数据平台的研发之路
- 这些数据科学家必备的技能,你拥有哪些?
- 自学成才的开发者有何优势和劣势?
- Gartner报告:正处于数据科学与机器学习工具 “大爆炸”的时代
- Ready Computing借助InterSystems IRIS医疗版为医疗机构提供具有高度互操作性和可扩展性的解决方案