您当前的位置:首页 > 电脑百科 > 程序开发 > 编程百科

FastAPI入门

时间:2020-10-12 10:07:49  来源:  作者:

之前一直用Flask,今年看到这个FastAPI框架,感觉还不错,体验了下,很容易就入门。

FastAPI入门

开始学习

FastAPI特点

FastAPI入门

官方描述

从官方的描述来看,有以下特点:

  • 高性能,与NodeJS和Go相当,最快的Python 框架之一。
  • 快速编写代码:将功能开发的速度提高大约200%至300%。
  • 更少的错误:减少约40%的人为错误(开发人员)
  • 直观:强大的编辑器支持,花费调试时间更少。
  • 简易:旨在易于使用和学习, 减少阅读文档的时间。
  • 简短:减少代码重复
  • 稳定健壮:获取可用于生产环境的代码, 具有自动交互式文档。
  • 标准化: 基于(并完全兼容)API的开放标准:OpenAPI(以前称为Swagger)和JSON模式。

 

版本要求

Python 3.6+

 

安装

$ pip install fastapi
$ pip install uvicorn

 

入门例子

 

# main.py
from fastapi import FastAPI
App = FastAPI()@app.get("/")
def read_root():    return {"Hello": "World"}
@app.get("/items/{item_id}")
def read_item(item_id: int, q: str = None):    return {"item_id": item_id, "q": q}

 

如果是异步,可以这么写:

# main.py
from fastapi import FastAPI
app = FastAPI()@app.get("/")
async def read_root():    return {"Hello": "World"}
@app.get("/items/{item_id}")
async def read_item(item_id: int, q: str = None):    return {"item_id": item_id, "q": q}

 

启动方式

 

$ uvicorn main:app --reload --port 18080

参数说明:

 

  • main: main.py 文件(也可理解为Python模块).
  • app: main.py 中app = FastAPI()语句创建的app对象.
  • --reload: 在代码改变后重启服务器,只能在开发的时候使用
  • 默认端口是8000,可以使用`--port`来指定其他端口

 

启动后输出:

INFO:     Uvicorn running on http://127.0.0.1:18080 (Press CTRL+C to quit)
INFO:     Started reloader process [19071]
INFO:     Started server process [19091]
INFO:     Waiting for application startup.
INFO:     Application startup complete.

 

可以看到服务已经启动,访问路径是http://127.0.0.1:18080 。

 

检查服务是否正常

 

打开你的浏览器,输入 http://127.0.0.1:18080 。

你将会看见JSON响应:

{"hello": "world"}

 

FastAPI入门

 


FastAPI入门

 

更简单的启动

 

#myapi.py
import uvicorn
if __name__ == "__main__":
    uvicorn.run("myapi:app", host="127.0.0.1", port=18080, log_level="info")

 

通过引入uvicorn库,那么我们就可以跟之前运行脚本的方式一样执行脚本就可以了。

 

python3 myapi.py

 

查看生成API的文档

  • Swagger UI风格文档:打开你的浏览器,输入 http://127.0.0.1:18080/docs 。

 

FastAPI入门

 

  • ReDoc风格文档打开你的浏览器,输入 http://127.0.0.1:18080/redoc 。

 

FastAPI入门

 

由于对外暴露文档,也是比较危险,那么我可不可以关闭API文档,答案是可以的,我们可以加一些参数来屏蔽它。

 

app = FastAPI(docs_url=None, openapi_url=None, redoc_url=None)

 

当你再次访问文档链接,会提示:

{"detail":"Not Found"}

 

FastAPI入门

 

是不是很简单,通过这个框架可以快速的完成接口。当然它还有更多的特性,这里就不展开了,有兴趣的可以自行查阅深入学习。



Tags:FastAPI   点击:()  评论:()
声明:本站部分内容及图片来自互联网,转载是出于传递更多信息之目的,内容观点仅代表作者本人,如有任何标注错误或版权侵犯请与我们联系(Email:2595517585@qq.com),我们将及时更正、删除,谢谢。
▌相关推荐
近日只是为了想尽办法为 Flask 实现 Swagger UI 文档功能,基本上要让 Flask 配合 Flasgger, 所以写了篇 Flask 应用集成 Swagger UI 。然而不断的 Google 过程中偶然间发现了...【详细内容】
2021-12-23  Tags: FastAPI  点击:(6)  评论:(0)  加入收藏
FastAPI 是一个用于构建 API 的现代、快速(高性能)的 web 框架,使用 Python 3.6+ 并基于标准的 Python 类型提示。关键特性: 快速:可与 NodeJS 和 Go 比肩的极高性能(归功于 Star...【详细内容】
2021-05-10  Tags: FastAPI  点击:(383)  评论:(0)  加入收藏
之前一直用Flask,今年看到这个FastAPI框架,感觉还不错,体验了下,很容易就入门。开始学习FastAPI特点官方描述从官方的描述来看,有以下特点: 高性能,与NodeJS和Go相当,最快的python...【详细内容】
2020-10-12  Tags: FastAPI  点击:(399)  评论:(0)  加入收藏
▌简易百科推荐
摘 要 (OF作品展示)OF之前介绍了用python实现数据可视化、数据分析及一些小项目,但基本都是后端的知识。想要做一个好看的可视化大屏,我们还要学一些前端的知识(vue),网上有很多比...【详细内容】
2021-12-27  项目与数据管理    Tags:Vue   点击:(1)  评论:(0)  加入收藏
程序是如何被执行的  程序是如何被执行的?许多开发者可能也没法回答这个问题,大多数人更注重的是如何编写程序,却不会太注意编写好的程序是如何被运行,这并不是一个好...【详细内容】
2021-12-23  IT学习日记    Tags:程序   点击:(9)  评论:(0)  加入收藏
阅读收获✔️1. 了解单点登录实现原理✔️2. 掌握快速使用xxl-sso接入单点登录功能一、早期的多系统登录解决方案 单系统登录解决方案的核心是cookie,cookie携带会话id在浏览器...【详细内容】
2021-12-23  程序yuan    Tags:单点登录(   点击:(8)  评论:(0)  加入收藏
下载Eclipse RCP IDE如果你电脑上还没有安装Eclipse,那么请到这里下载对应版本的软件进行安装。具体的安装步骤就不在这赘述了。创建第一个标准Eclipse RCP应用(总共分为六步)1...【详细内容】
2021-12-22  阿福ChrisYuan    Tags:RCP应用   点击:(7)  评论:(0)  加入收藏
今天想简单聊一聊 Token 的 Value Capture,就是币的价值问题。首先说明啊,这个话题包含的内容非常之光,Token 的经济学设计也可以包含诸多问题,所以几乎不可能把这个问题说的清...【详细内容】
2021-12-21  唐少华TSH    Tags:Token   点击:(9)  评论:(0)  加入收藏
实现效果:假如有10条数据,分组展示,默认在当前页面展示4个,点击换一批,从第5个开始继续展示,到最后一组,再重新返回到第一组 data() { return { qList: [], //处理后...【详细内容】
2021-12-17  Mason程    Tags:VUE   点击:(14)  评论:(0)  加入收藏
什么是性能调优?(what) 为什么需要性能调优?(why) 什么时候需要性能调优?(when) 什么地方需要性能调优?(where) 什么时候来进行性能调优?(who) 怎么样进行性能调优?(How) 硬件配...【详细内容】
2021-12-16  软件测试小p    Tags:性能调优   点击:(19)  评论:(0)  加入收藏
Tasker 是一款适用于 Android 设备的高级自动化应用,它可以通过脚本让重复性的操作自动运行,提高效率。 不知道从哪里听说的抖音 app 会导致 OLED 屏幕烧屏。于是就现学现卖,自...【详细内容】
2021-12-15  ITBang    Tags:抖音防烧屏   点击:(23)  评论:(0)  加入收藏
11 月 23 日,Rust Moderation Team(审核团队)在 GitHub 上发布了辞职公告,即刻生效。根据公告,审核团队集体辞职是为了抗议 Rust 核心团队(Core team)在执行社区行为准则和标准上...【详细内容】
2021-12-15  InfoQ    Tags:Rust   点击:(24)  评论:(0)  加入收藏
一个项目的大部分API,测试用例在参数和参数值等信息会有很多相似的地方。我们可以复制API,复制用例来快速生成,然后做细微调整既可以满足我们的测试需求1.复制API:在菜单发布单...【详细内容】
2021-12-14  AutoMeter    Tags:AutoMeter   点击:(20)  评论:(0)  加入收藏
相关文章
    无相关信息
最新更新
栏目热门
栏目头条