FastAPI 學習之路（二十）介面檔案配置相關-有解無憂

　系列文章：

　　FastAPI 學習之路（一）fastapi--高性能web開發框架

　　FastAPI 學習之路（二）

　　FastAPI 學習之路（三）

　　FastAPI 學習之路（四）

　　FastAPI 學習之路（五）

FastAPI 學習之路（六）查詢引數，字串的校驗

　　FastAPI 學習之路（七）字串的校驗

　 FastAPI 學習之路（八）路徑引數和數值的校驗

　　FastAPI 學習之路（九）請求體有多個引數如何處理？

　　FastAPI 學習之路（十）請求體的欄位

FastAPI 學習之路（十一）請求體 - 嵌套模型

　 FastAPI 學習之路（十二）介面幾個額外資訊和額外資料型別

FastAPI 學習之路（十三）Cookie 引數,Header引數

　 FastAPI 學習之路（十四）回應模型

　　FastAPI 學習之路（十五）回應狀態碼

　 FastAPI 學習之路（十六）Form表單

FastAPI 學習之路（十七）上傳檔案

FastAPI 學習之路（十八）表單與檔案

　　FastAPI 學習之路（十九）處理錯誤

我們都知道，fastApi給我們提供了介面檔案，在我們的實際開發中，我們會有很多的介面，有些介面需要分組，比如我們對于登錄注冊相關的模塊，可以統一放在登錄，那么我們如何實作劃分呢，

from fastapi import FastAPI
app = FastAPI()
@app.post("/login/", tags=["login"])
def login(username: str,password:str):
    if username == "leizi" and password=="123":
        return "success"
    return {"name": username}
@app.post("/regin/", tags=["login"])
def regin(username: str,password:str):
    return {"name": username}

我們看下，介面檔案

可以看到，我們實作的登錄的模塊是成功的，

我們來看下，如何對介面增加一個簡單的描述

from fastapi import FastAPI
app = FastAPI()
@app.post("/login/", tags=["login"],description="這是登錄模塊")
def login(username: str,password:str):
    if username == "leizi" and password=="123":
        return "success"
    return {"name": username}
@app.post("/regin/", tags=["login"])
def regin(username: str,password:str):
    return {"name": username}

我們看下介面

如果我們想要把所有的注釋以給讀取出來，然后展示在描述中，fastapi也給我們做了很好的封裝，我們可以簡單的看下代碼

from fastapi import FastAPI
app = FastAPI()
@app.post("/login/", tags=["login"],summary="這是登錄模塊")
def login(username: str,password:str):
    """
    登錄
    - param username:  用戶名
    - param password:  密碼
    - return: 回傳是否成功
    """
    if username == "leizi" and password=="123":
        return "success"
    return {"name": username}
@app.post("/regin/", tags=["login"])
def regin(username: str,password:str):
    return {"name": username}

我們看下最后的實作的效果

如果我們要標注介面啟用怎么實作呢

from fastapi import FastAPI
app = FastAPI()
@app.post("/login/", tags=["login"],summary="這是登錄模塊")
def login(username: str,password:str):
    """
    登錄
    - param username:  用戶名
    - param password:  密碼
    - return: 回傳是否成功
    """
    if username == "leizi" and password=="123":
        return "success"
    return {"name": username}
@app.post("/regin/", tags=["login"],deprecated=True)
def regin(username: str,password:str):
    return {"name": username}

我們可以介面檔案的展示

文章首發在公眾號，歡迎關注，

轉載請註明出處，本文鏈接：https://www.uj5u.com/houduan/322981.html

標籤：其他

上一篇：你不知道的CS模式的行程管理工具，狀態監測、專案啟停一目了然！

下一篇：一個簡單的超市訂單管理系統（4）-用戶注銷和權限攔截