文章目录

fastapi框架一、预备知识点1.1、http协议（1）简介（2） http协议特性（3）http请求协议与响应协议

1.2、api接口

二、quick start1、简单案例2、交互API文档3、Fastapi开发web程序流程总结

fastapi框架

Fastapi，一个用于构建 API 的现代、快速（高性能）的web框架。

fastapi的两个核心组件：Starlette，Pydantic

fastapi是建立在Starlette和Pydantic基础上的，Pydantic是一个基于Python类型提示来定义数据验证、序列化和文档的库。

Starlette是一种轻量级的ASGI框架/工具包，是构建高性能Asyncio服务的理性选择。

快速：可与 NodeJS 和 Go 比肩的极高性能（归功于 Starlette 和 Pydantic），是最快的 Python web 框架之一。高效编码：提高功能开发速度约 200％ 至 300％。更少bug：减少约 40％ 的人为（开发者）导致错误。智能：极佳的编辑器支持。处处皆可自动补全，减少调试时间。简单：设计的易于使用和学习，阅读文档的时间更短。简短：使代码重复最小化。通过不同的参数声明实现丰富功能。健壮：生产可用级别的代码。还有自动生成的交互式文档。

依赖：Python 3.6 及更高版本，FastAPI 站在以下巨人的肩膀之上

FastApi是站在前人肩膀上，集成了多种框架的优点的新秀框架。

它出现的比较晚，2018年底才发布在github上。广泛应用于当前各种前后端分离的项目开发，测试运维自动化以及微服务的场景中。

Pydantic使用来处理数据的，它可以将前端传来的数据转换成之前定义好的类里面的数据类型

案例：

<code>from datetime import datetime

from pydantic import BaseModel, PositiveInt

#构造数据模型

class User(BaseModel):

#类型声明

id: int

name: str = 'John Doe' #相当于有默认值的，John Doe

signup_ts: datetime | None

tastes: dict[str, PositiveInt]

#模拟前端传给后端的数据

external_data = {

'id': '123',

'signup_ts': '2019-06-01 12:22',

'tastes': {

'wine': 9,

b'cheese': 7,

'cabbage': '1',

},

}

#BaseModel类的强大之处在于，可以将数据进行转换，转换成类里面声明的相关数据类型

user = User(**external_data)

print(user.id)

#> 123

print(user.model_dump())

我们看下前端传来的数据，明显不是类User里面定义的数据类型

但是，Pydantic里面的BaseModel可以转换

我们运行下代码，看下打印，已经将123字符串类型转换为int类型，将字符串日期转换成日期类型

但是，如果我们传递的类型不能通过类型转换，就会报错

#user是个对象

print(user,type(user))

#将对象转换成字典

print(user.dict())

一、预备知识点

1.1、http协议

什么是请求头请求体，响应头响应体URL地址包括什么get请求和post请求到底是什么Content-Type是什么

（1）简介

HTTP协议是Hyper Text Transfer Protocol（超文本传输协议）的缩写,是用于万维网（WWW:World Wide Web ）服务器与本地浏览器之间传输超文本的传送协议。

HTTP是一个属于应用层的面向对象的协议，由于其简捷、快速的方式，适用于分布式超媒体信息系统。

它于1990年提出，经过几年的使用与发展，得到不断地完善和扩展。HTTP协议工作于客户端-服务端架构为上。

浏览器作为HTTP客户端通过URL向HTTP服务端即WEB服务器发送所有请求。Web服务器根据接收到的请求后，向客户端发送响应信息。

（2） http协议特性

(1) 基于TCP/IP协议

http协议是基于TCP/IP协议之上的应用层协议。

(2) 基于请求－响应模式

HTTP协议规定,请求从客户端发出,最后服务器端响应该请求并 返回。换句话说,肯定是先从客户端开始建立通信的,服务器端在没有 接收到请求之前不会发送响应

(3) 无状态保存

HTTP是一种不保存状态,即无状态(stateless)协议。HTTP协议 自身不对请求和响应之间的通信状态进行保存。也就是说在HTTP这个 级别,协议对于发送过的请求或响应都不做持久化处理。

使用HTTP协议,每当有新的请求发送时,就会有对应的新响应产 生。协议本身并不保留之前一切的请求或响应报文的信息。这是为了更快地处理大量事务,确保协议的可伸缩性,而特意把HTTP协议设计成 如此简单的。

(4) 短连接

HTTP1.0默认使用的是短连接。浏览器和服务器每进行一次HTTP操作，就建立一次连接，任务结束就中断连接。

HTTP/1.1起，默认使用长连接。要使用长连接，客户端和服务器的HTTP首部的Connection都要设置为keep-alive，才能支持长连接。

HTTP长连接，指的是复用TCP连接。多个HTTP请求可以复用同一个TCP连接，这就节省了TCP连接建立和断开的消耗。

（3）http请求协议与响应协议

http协议包含由浏览器发送数据到服务器需要遵循的请求协议与服务器发送数据到浏览器需要遵循的请求协议。

用于HTTP协议交互的信被为HTTP报文。请求端(客户端)的HTTP报文 做请求报文,响应端(服务器端)的 做响应报文。HTTP报文本身是由多行数据构成的字文本。

一个完整的URL包括：协议、ip、端口、路径、参数

例如： https://www.baidu.com/s?wd=yuan 其中https是协议，www.baidu.com 是IP，端口默认443，/s是路径，参数是wd=yuan

请求方式: get与post请求

GET提交的数据会放在URL之后，以?分割URL和传输数据，参数之间以&相连，如EditBook?name=test1&id=123456. POST方法是把提交的数据放在HTTP包的请求体中.GET提交的数据大小有限制（因为浏览器对URL的长度有限制），而POST方法提交的数据没有限制

响应状态码：状态码的职 是当客户端向服务器端发送请求时, 返回的请求 结果。借助状态码,用户可以知道服务器端是正常 理了请求,还是出 现了 。状态码如200 OK,以3位数字和原因 组成。

1.2、api接口

在开发Web应用中，有两种应用模式：

前后端不分离[客户端看到的内容和所有界面效果都是由服务端提供出来的。]

我们使用socket，来创建一个web应用程序

<code>import socket

sock = socket.socket()

sock.bind(('127.0.0.1',8080))

sock.listen(128)

while True:

con,addr = sock.accept() #阻塞等待客户端连接

data = con.recv(1024)

print('客户端发来的信息',data)

con.send(b'HTTP/1.1 200 ok\r\nserver:jingtian\r\ncontent-type:application/json\r\n\r\n{serverdata:hello,world}')

con.close()

浏览器访问

拿到数据

看下我们设置的响应头

但是，我们每次如果都手动写请求，响应，那对开发来说将显得非常麻烦，因此我们迫切需要web开发框架来简化我们得开发步骤。

前后端分离【把前端的界面效果(html，css，js分离到另一个服务端，python服务端只需要返回数据即可)】

前端形成一个独立的网站，服务端构成一个独立的网站

应用程序编程接口（Application Programming Interface，API接口），就是应用程序对外提供了一个操作数据的入口，这个入口可以是一个函数或类方法，也可以是一个url地址或者一个网络地址。

当客户端调用这个入口，应用程序则会执行对应代码操作，给客户端完成相对应的功能。

当然，api接口在工作中是比较常见的开发内容，有时候，我们会调用其他人编写的api接口，有时候，我们也需要提供api接口给其他人操作。

由此就会带来一个问题，api接口往往都是一个函数、类方法、或者url或其他网络地址，不管是哪一种，当api接口编写过程中，我们都要考虑一个问题就是这个接口应该怎么编写？

接口怎么写的更加容易维护和清晰，这就需要大家在调用或者编写api接口的时候要有一个明确的编写规范！！！

为了在团队内部形成共识、防止个人习惯差异引起的混乱，我们都需要找到一种大家都觉得很好的接口实现规范，而且这种规范能够让后端写的接口，用途一目了然，减少客户端和服务端双方之间的合作成本。

目前市面上大部分公司开发人员使用的接口实现规范主要有：restful、RPC。

REST全称是Representational State Transfer，中文意思是表述（编者注：通常译为表征）性状态转移。 它首次出现在2000年Roy Fielding的博士论文中。

RESTful是一种专门为Web 开发而定义API接口的设计风格，尤其适用于前后端分离的应用模式中。

关键：面向资源开发

这种风格的理念认为后端开发任务就是提供数据的，对外提供的是数据资源的访问接口，所以在定义接口时，客户端访问的URL路径就表示这种要操作的数据资源。

而对于数据资源分别使用POST、DELETE、GET、UPDATE等请求动作来表达对数据的增删查改。

restful规范是一种通用的规范，不限制语言和开发框架的使用。事实上，我们可以使用任何一门语言，任何一个框架都可以实现符合restful规范的API接口。

二、quick start

1、简单案例

安装

pip install fastapi

你还会需要一个 ASGI 服务器，生产环境可以使用 Uvicorn

pip install uvicorn

from fastapi import FastAPI # FastAPI 是一个为你的 API 提供了所有功能的 Python 类。

app = FastAPI() # 这个实例将是创建你所有 API 的主要交互对象。这个 app 同样在如下命令中被 uvicorn 所引用

@app.get(“/”)

async def root():

return {“message”: “Hello jingtian”}

通过以下命令运行服务器：

uvicorn main:app --reload

INFO: Will watch for changes in these directories: [‘F:\pythonitems\myfastapi’]

INFO: Uvicorn running on http://127.0.0.1:8080 (Press CTRL+C to quit)

INFO: Started reloader process [18824] using StatReload

INFO: Started server process [1668]

INFO: Waiting for application startup.

INFO: Application startup complete.

也可以直接运行：

<code>if __name__ == '__main__':

#注意，run的第一个参数 必须是文件名:应用程序名

uvicorn.run("quickstart:app", port=8080, reload=True)

实战：

from fastapi import FastAPI # FastAPI 是一个为你的 API 提供了所有功能的 Python 类。

import uvicorn

#创建应用程序，app是应用程序名

app = FastAPI() # 这个实例将是创建你所有 API 的主要交互对象。这个 app 同样在如下命令中被 uvicorn 所引用

#异步的请求参数，函数加上async。针对什么路由，就写上什么路径

@app.get("/")

async def home():

return { "user_id": 1002}

@app.get("/shop")

async def shop():

return { "shop": "商品信息"}

if __name__ == '__main__':

#注意，run的第一个参数 必须是文件名:应用程序名

uvicorn.run("quickstart:app", port=8080, reload=True)

在浏览器，访问的时候，域名后面跟什么路由，就相应地只想server端配置的相关路由下面的函数

http://127.0.0.1:8080

http://127.0.0.1:8080/shop

2、交互API文档

fastapi有着非常棒的交互式 API 文档，这一点很吸引人。

你将会看到自动生成的交互式 API 文档。

http://127.0.0.1:8080/docs

点一下try it out

点击Excute

可以拿到响应数据，响应头等数据

借助于web框架，我们开发人员只需要专注于业务本身，而无需为繁琐的格式费心费力，大大简化了我们得开发流程。

3、Fastapi开发web程序流程总结

Fastapi开发web程序流程：

（1）导入 FastAPI。

（2）创建一个 app 实例。

（3）编写一个路径操作装饰器（如 @app.get(“/”)）

（4）编写一个路径操作函数（如上面的 def root(): …）

（5）定义返回值

（6）运行开发服务器（如 uvicorn main:app --reload）