FastApi如何快速構(gòu)建一個(gè)web項(xiàng)目的實(shí)現(xiàn)

更新時(shí)間：2023年03月24日 08:36:18 作者：Li-boss

本文主要介紹了FastApi如何快速構(gòu)建一個(gè)web項(xiàng)目的實(shí)現(xiàn)，文中通過(guò)示例代碼介紹的非常詳細(xì)，對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值，需要的朋友們下面隨著小編來(lái)一起學(xué)習(xí)學(xué)習(xí)吧

已經(jīng)使用FastApi很久了。這個(gè)一個(gè)非常優(yōu)秀的框架。和flask一樣能夠快速構(gòu)建一個(gè)web服務(wù)。開(kāi)發(fā)效率非常之高。今天我一個(gè)Demo來(lái)介紹一下這個(gè)框架的使用。供大家學(xué)習(xí)參考。

項(xiàng)目介紹

本項(xiàng)目主要介紹fastapi快速編寫(xiě)web服務(wù)，通過(guò)案例分別介紹項(xiàng)目搭建,接口編寫(xiě),文檔生成,模板渲染,excel讀取,鏡像部署等項(xiàng)目中常見(jiàn)的問(wèn)題。

項(xiàng)目目錄構(gòu)成

data
  learning.xlsx
templates
   index.html
main.py
Dockerfile
README.md
requirements.txt

data 目錄是存放Excel數(shù)據(jù)文件

templates 目錄是存放html模板文件

main.py 是項(xiàng)目的入口文件

Dockerfile 是項(xiàng)目通過(guò)Docker部署構(gòu)建鏡像的文件

README.md 是項(xiàng)目的介紹文件

requirements.txt 是項(xiàng)目的依賴(lài)文件

項(xiàng)目?jī)?nèi)容

數(shù)據(jù)文件內(nèi)容

數(shù)據(jù)文件內(nèi)容見(jiàn)下圖
data/learning.xlsx

在這里插入圖片描述

模板渲染

見(jiàn)代碼
templates/index.html

<!DOCTYPE html>
<html lang="en">

<head>
    <meta charset="UTF-8">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <title>編程語(yǔ)言學(xué)習(xí)Demo</title>
</head>

<body>
    <h1>編程語(yǔ)言學(xué)習(xí)</h1>
    <div>
        <div style="color:red; ">
            <b>注意：這是一個(gè)學(xué)習(xí)的Demo</b>
        </div>
    </div>

    <table>
        <tr>
            <td>語(yǔ)言</td>
            <td>學(xué)習(xí)目標(biāo)</td>
            <td>學(xué)習(xí)地址</td>
        </tr>
        {% for my_dict in info %}
        <tr>
            <!-- 模板過(guò)濾器使用 -->
            <td>{{my_dict.語(yǔ)言|replace('nan','')}}</td>
            <td>{{my_dict.學(xué)習(xí)目標(biāo)|replace('nan','')}}</td>
            <td><a href="{{my_dict.URL|e}}" target="_blank">{{my_dict.學(xué)習(xí)地址|replace('nan','')}}</td>
        </tr>
        {% endfor %}
    </table>

    <style>
        table {
            /*為頁(yè)面中所有的table標(biāo)簽添加樣式*/
            width: 1800px;
            /*讓表格居中顯示*/
            border: black 1px solid;
            /*添加邊框*/
            border-spacing: 0px;
            /* 去掉table
            /*標(biāo)簽及其子標(biāo)簽邊框之間的白色空隙*/
            border-collapse: collapse;
            /*去掉重合線(xiàn)*/
        }

        th {
            /*為頁(yè)面中所有的th標(biāo)簽添加樣式*/
            border: black 1px solid;
            /*添加邊框*/
        }

        td {
            /*為頁(yè)面中所有的td標(biāo)簽添加樣式*/
            border: black 1px solid;

        }
    </style>

</body>

</html>

python代碼

# 在視圖函數(shù)中傳入request對(duì)象，用于在模板對(duì)象中傳遞上下文（同時(shí)接收路徑參數(shù)info，將其傳遞到上下文中）
@app.get("/", summary="這是一個(gè)模板渲染示例")
async def index(request: Request):
    # 加載excel數(shù)據(jù)
    result = pd.read_excel(file_path)
    # 將excel數(shù)據(jù)轉(zhuǎn)化為JSON對(duì)象
    info = result.to_dict("records")
    # 返回一個(gè)模板對(duì)象，同時(shí)使用上下文中的數(shù)據(jù)對(duì)模板進(jìn)行渲染
    return templates.TemplateResponse(
        name="index.html", context={"request": request, "info": info}
    )

同步接口

見(jiàn)代碼

@app.get("/index", summary="這是一個(gè)同步接口")
def index():
    return {"key": "這是一個(gè)同步接口返回的數(shù)據(jù)"}

異步接口

見(jiàn)代碼

@app.get("/index/async", summary="這是一個(gè)異步接口")
def index_async():
    return {"key": "這是一個(gè)異步接口返回的數(shù)據(jù)"}

項(xiàng)目入口文件

見(jiàn)代碼
main.py

import os
from pathlib import Path

import pandas as pd
import uvicorn
from fastapi import FastAPI

# 導(dǎo)入Request上下文對(duì)象，用來(lái)在前后臺(tái)之間傳遞參數(shù)
from starlette.requests import Request

# 導(dǎo)入jinja2模板引擎對(duì)象，用于后續(xù)使用
from starlette.templating import Jinja2Templates

app = FastAPI()

# 實(shí)例化一個(gè)模板引擎對(duì)象，指定模板所在路徑
templates = Jinja2Templates(directory="templates")
data_path = os.path.abspath(Path("data"))
# 獲取文件路徑
file_path = os.path.join(data_path, "learning.xlsx")


# 在視圖函數(shù)中傳入request對(duì)象，用于在模板對(duì)象中傳遞上下文（同時(shí)接收路徑參數(shù)info，將其傳遞到上下文中）
@app.get("/", summary="這是一個(gè)模板渲染示例")
async def index(request: Request):
    # 加載excel數(shù)據(jù)
    result = pd.read_excel(file_path)
    # 將excel數(shù)據(jù)轉(zhuǎn)化為JSON對(duì)象
    info = result.to_dict("records")
    # 返回一個(gè)模板對(duì)象，同時(shí)使用上下文中的數(shù)據(jù)對(duì)模板進(jìn)行渲染
    return templates.TemplateResponse(
        name="index.html", context={"request": request, "info": info}
    )


@app.get("/index/async", summary="這是一個(gè)異步接口")
def index_async():
    return {"key": "這是一個(gè)異步接口返回的數(shù)據(jù)"}


@app.get("/index", summary="這是一個(gè)同步接口")
def index():
    return {"key": "這是一個(gè)同步接口返回的數(shù)據(jù)"}


if __name__ == "__main__":
    # 啟動(dòng)程序
    uvicorn.run(app="main:app", host="0.0.0.0", port=8000, reload=True)

項(xiàng)目依賴(lài)

requirements.txt

fastapi==0.94.1 
uvicorn==0.21.0
jinja2==3.1.2
pandas==1.5.3
openpyxl==3.1.2
gunicorn==20.1.0

項(xiàng)目部署

項(xiàng)目構(gòu)建文件
Dockerfile

FROM  python:3.8.16-slim-buster 
LABEL MAINTAINER Li-boss "CSDN Li-boss"
COPY ./ /var/demo
RUN pip install -r /var/demo/requirements.txt -i https://pypi.tuna.tsinghua.edu.cn/simple
WORKDIR /var/demo
EXPOSE 8000
CMD gunicorn main:app  -b 0.0.0.0:8000 --forwarded-allow-ips='*' -w 4 -k uvicorn.workers.UvicornWorker

進(jìn)入到Dockerfile所在的目錄，執(zhí)行下面的命令構(gòu)建鏡像.

docker build test_demo:v1 .

啟動(dòng)容器

docker run -it -p 8000:8000 test_demo:v1

訪(fǎng)問(wèn)地址

http://localhost:8000/
# 文檔地址：
http://localhost:8000/docs
http://localhost:8000/redoc

訪(fǎng)問(wèn)效果

文檔效果一

在這里插入圖片描述

文檔效果二

在這里插入圖片描述

模板渲染效果一

在這里插入圖片描述

到此這篇關(guān)于FastApi如何快速構(gòu)建一個(gè)web項(xiàng)目的實(shí)現(xiàn)的文章就介紹到這了,更多相關(guān)FastApi構(gòu)建web項(xiàng)目?jī)?nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

您可能感興趣的文章: