FastAPI 学习之路(三十九)对开发接口进行测试

概况

对于开发好的接口需要进行测试之后才能发布。当我们在开发的时候,没有提前测试,我们也要对我们自己的接口进行测试,那么FastApi自身也带有针对开发的接口进行测试的功能。我们看下FastApi官方给我们提供了什么样的支持。

接口还是基于FastAPI 学习之路(三十七)元数据和文档 URL实现。我们看下如何测试。

TestClient

from routers.items import item_router
from routers.users import user_router
from fastapi import FastAPI


app = FastAPI(
    title="这是测试Title",
    description="这是测试description",
    version="这是测试version"
)

app.include_router(user_router, prefix="/u", tags=["users"])
app.include_router(item_router, prefix="/i", tags=["items"])

# ------------------------------以下是进行测试的方法---------------------------------
# 这是fastapi提供给我们来进行测试的类
from fastapi.testclient import TestClient

client = TestClient(app)


def test_get_user_view():
    response = client.get("/u/user?uid=1")
    assert response.status_code == 200
    assert isinstance(response.json(), dict) and "email" in response.json()


if __name__ == '__main__':
    test_get_user_view()

其实很简单,fastapi里面有个模块,我们直接导入进来,编写用例即可。

运行看下:

可是我们简单的写的,运行后只是没有报错而已。证明执行成功,但是在实际中,我们做还是不够的,我们想要看着是否执行通过。如何实现呢。

我们可以使用python自带的unittest来组织测试用例。

unittest

我们看下改造后的。

from routers.items import item_router
from routers.users import user_router
from fastapi import FastAPI


app = FastAPI(
    title="这是测试Title",
    description="这是测试description",
    version="这是测试version"
)

app.include_router(user_router, prefix="/u", tags=["users"])
app.include_router(item_router, prefix="/i", tags=["items"])

# ------------------------改造------------------------------
import unittest
from fastapi.testclient import TestClient

client = TestClient(app)


class FastApiTest(unittest.TestCase):

    def setUp(self) -> None:
        self.client = TestClient(app)

    def tearDown(self) -> None:
        self.client = None

    def test_get_user_view(self):
        response = self.client.get("/u/user?uid=3")
        self.assertEqual(response.status_code, 200)
        self.assertIn("email", response.json())

    def test_get_item_by_uid_view(self):
        response = self.client.get("/i/items/1")
        self.assertEqual(response.status_code, 200)
        self.assertEqual(response.json()[0]["id"], 3)


if __name__ == '__main__':
    unittest.main()

运行看下:

当然,你也可以单独创建一个test文件,将测试流程单独放置于test文件中。

这样我们就实现了对fastapi在开发过程中的接口测试,很简单,我们也不用启动服务端。

相关推荐
skywalk816319 小时前
三周精通FastAPI:33 在编辑器中调试
python·编辑器·fastapi
敲代码不忘补水2 天前
使用 PyCharm 构建 FastAPI 项目:零基础入门 Web API 开发
后端·python·fastapi
skywalk81633 天前
三周精通FastAPI:32 探索如何使用pytest进行高效、全面的项目测试!
开发语言·python·fastapi
德育处主任4 天前
『FastAPI』快速掌握“请求与响应”的基础用法
后端·python·fastapi
花酒锄作田6 天前
[python]Gunicorn加持下的Flask性能测试
python·nginx·golang·flask·fastapi
萤火架构8 天前
使用FastAPI整合Gradio和Django
django·fastapi·gradio
练习两年半的工程师9 天前
建立一个简单的todo应用程序(前端React;后端FastAPI;数据库MongoDB)
前端·数据库·react.js·fastapi
岳涛@心馨电脑12 天前
【硬啃Dash-Fastapi-Admin】03-requirements-pg.txt 速览
信息可视化·fastapi·dash
skywalk816312 天前
三周精通FastAPI:16 Handling Errors处理错误
开发语言·python·fastapi
zhiyong_will13 天前
Uvicorn 原理及源码分析
fastapi