Sub applications
正在阅读# 子应用 - 挂载 { #sub-applications-mounts }
如果你需要拥有两个独立的 FastAPI 应用,各自拥有独立的 OpenAPI 和文档界面,你可以创建一个主应用并"挂载"一个(或多个)子应用。
挂载 FastAPI 应用¶
"挂载"意味着在特定路径下添加一个完全"独立"的应用,该子应用将负责处理该路径下的所有内容,包括子应用中声明的 路径操作。
顶层应用¶
首先,创建主要的顶层 FastAPI 应用及其 路径操作:
from fastapi import FastAPI
app = FastAPI()
@app.get("/app")
def read_main():
return {"message": "Hello World from main app"}
subapi = FastAPI()
@subapi.get("/sub")
def read_sub():
return {"message": "Hello World from sub API"}
app.mount("/subapi", subapi)
子应用¶
然后,创建你的子应用及其 路径操作。
这个子应用只是另一个标准的 FastAPI 应用,但它将被"挂载":
from fastapi import FastAPI
app = FastAPI()
@app.get("/app")
def read_main():
return {"message": "Hello World from main app"}
subapi = FastAPI()
@subapi.get("/sub")
def read_sub():
return {"message": "Hello World from sub API"}
app.mount("/subapi", subapi)
挂载子应用¶
在你的顶层应用 app 中,挂载子应用 subapi。
在本例中,它将被挂载到路径 /subapi:
from fastapi import FastAPI
app = FastAPI()
@app.get("/app")
def read_main():
return {"message": "Hello World from main app"}
subapi = FastAPI()
@subapi.get("/sub")
def read_sub():
return {"message": "Hello World from sub API"}
app.mount("/subapi", subapi)
检查自动生成的 API 文档¶
现在,使用 fastapi 命令运行你的文件:
$ fastapi dev main.py
<span style="color: green;">INFO</span>: Uvicorn 运行在 http://127.0.0.1:8000 (按 CTRL+C 退出)
然后打开文档界面 http://127.0.0.1:8000/docs。
你将看到主应用的自动 API 文档,仅包含其自身的 路径操作:

接着,打开子应用的文档界面 http://127.0.0.1:8000/subapi/docs。
你将看到子应用的自动 API 文档,仅包含其自身的 路径操作,且全部位于正确的子路径前缀 /subapi 下:

如果你尝试与这两个用户界面交互,它们都能正常工作,因为浏览器能够与每个特定的应用或子应用通信。
技术细节:root_path¶
当你如上所述挂载子应用时,FastAPI 会通过 ASGI 规范中的 root_path 机制来传递子应用的挂载路径。
这样,子应用就知道在文档界面中使用该路径前缀。
子应用也可以有自己的挂载子应用,一切都能正常工作,因为 FastAPI 会自动处理所有这些 root_path。
你可以在 Behind a Proxy 部分了解更多关于 root_path 以及如何显式使用它的内容。