在日常运维工作中,经常性的会创造出一些快速脚本,用来提高工作效率.一直在想有没有可能写一个Web工具,把这些常用的东西收集起来,用的时候直接点击拿到结果.这样即方便又能避免输错还不用登陆服务器显得更有效率. 直到我遇到了fastapi突然眼前一亮,不就是这货吗?让我等的好苦!

fastapi是什么

FastAPI 是一个用于构建 API 的现代、快速(高性能)的 web 框架,使用 Python 3.6+ 并基于标准的 Python 类型提示。

关键特性:

  • 快速:可与 NodeJS 和 Go 比肩的极高性能(归功于 Starlette 和 Pydantic)。最快的 Python web 框架之一。

  • 高效编码:提高功能开发速度约 200% 至 300%。*

  • 更少 bug:减少约 40% 的人为(开发者)导致错误。*

  • 智能:极佳的编辑器支持。处处皆可自动补全,减少调试时间。

  • 简单:设计的易于使用和学习,阅读文档的时间更短。

  • 简短:使代码重复最小化。通过不同的参数声明实现丰富功能。bug 更少。

  • 健壮:生产可用级别的代码。还有自动生成的交互式文档。

  • 标准化:基于(并完全兼容)API 的相关开放标准:OpenAPI (以前被称为 Swagger) 和 JSON Schema。

以上摘自官方文档 https://fastapi.tiangolo.com/zh/

我自己的一些感受

天然集成swagger,有了这个靠山,自然有了以下几大能力

  • 界面有了 命令行很酷,键指如飞也很让人羡慕,但也仅而已了,真正牛掰的能力是复制,一旦你自身拥有了一项能力,你的团队同时俱备的这项能力,而且同你个人操作没有差别.这应该就是Web一直长盛不衰的本质所在.

  • 入参出参一目了然 什么类型,是否必须,很直观的显示出来.以前做项目,写完实现,写注释,还要写接口文档给调用方,实在是费时费力,时间久了自己也不记得了.现在好了文档自动生成不说,忘记了直接打开看

  • 界面调试 你很容易在浏览器里,直接调试你正在编写的接口.以前不觉得的什么,GET接口直接浏览器打开就好了,POST接口自己用curl或者postman造一下就行.现在好了直接内置这些技能,还给你自带一个curl的命令,方便你在命令行测试.当然输出也一目了然.

  • 开发效率 这个要从几方面来说

    • 自动重启 这个勉强算是吧,确切的说是uvicorn的能力,加了--reload参数,监控文件变化,自动重启
    • 参数校验 明确定义参数和类型,少参数和类型不对的情况,fastapi帮你处理,这无形中是巨大的时间成本.
    • 返回结果 默认json格式返回,以前处理完的结果,别管是数组还是字典都要json.dump一下.现在直接return好了.
  • 兼容flask 确切的说不能算兼容,只能说语法类型,超级容易转换,只是获取参数的形式变一变,校验参数的部分拿掉,中间逻辑处理不变,返回结果时拿掉json转换 举例 转换前: 转换后: 其实早就知道swagger这一神奇存在,甚至在我用上了fastapi还专门搜索了一下swagger在nodejs,golang,java等的集成方式,发现都是以插件的形式存在,需要不少的定制才能work,当然flask也可以集成swagger,只是有天然集成的存在实在找不出继续使用flask的理由 一口气,泛泛的纸上谈兵说了这么多,后面还会有一些相应的主题跟进,比如写一个比较全的例子,入门更容易一些,还有一些相对高级的诸如安全相关的东西.