要想启动fastapi我们需要依赖一个python服务器,在fastapi中本篇介绍2种.如果使用pycharm启动,可以参考下面类似案例,正常来说vscode能启动,pycharm都没问题。
前提
需要先进行虚拟环境的配置。如果还不知道如何配置,可以参考下面的文章先配置后在下一步。
编写启动配置launch.json
一般有两种常用服务器推荐uvicorn和granian
使用uvicorn
参数--reload运行热更新,端口配置为8888,默认是8000
json
{
"version": "0.2.0",
"configurations": [
{
"name": "lga", // 调试器名称
"type": "debugpy", // 使用 VS Code 推荐的 Python 调试器
"request": "launch", // 启动新进程(而非附加到现有进程)
"module": "uvicorn", // 指定通过 uvicorn 模块启动应用
"args": ["main:app", "--reload", "--port", "8888",], // 启动参数
"justMyCode": false, // 允许调试第三方库代码
"env": {
"PYDEVD_DISABLE_FILE_VALIDATION": "1" // 禁用冻结模块检测(解决某些环境报错)
}
}
]
}
使用granian
granian是用rust写的一个python服务器,目前是python中最快的服务器,所以也是比较推荐的一个方案
参数运行热更新,端口8888,access-log参数必须,否则没有任何日志输出
json
{
"version": "0.2.0",
"configurations": [
{
"name": "lga", // 调试器名称
"type": "debugpy", // 使用 VS Code 推荐的 Python 调试器
"request": "launch", // 启动新进程(而非附加到现有进程)
"module": "granian", // 指定通过 granian 模块启动应用
"args": ["main:app", "--interface", "asgi", "--reload", "--port", "8888","--access-log"], // 启动参数
"justMyCode": false, // 允许调试第三方库代码
"env": {
"PYDEVD_DISABLE_FILE_VALIDATION": "1" // 禁用冻结模块检测(解决某些环境报错)
}
}
]
}
然后我们可以点击f5进行启动或者左侧的面板按钮启动。
特别说明PYDEVD_DISABLE_FILE_VALIDATION 设置1一般是在有对要打包成可执行文件需要,否则有可能报错。
代码启动方案
这个方案pycharm也能用,需要改一点点的代码
ini
if __name__ == "__main__":
Env.start()
ini
class Env:
@staticmethod
def start():
import uvicorn
app = FastAPI()
uvicorn.run(app, host="0.0.0.0", reload=False, port=8888, workers=1)
为啥一个文件就搞定要拆呢?这个是一个优化技巧,如果将uvicorn的导入放在全局,当其他模块导入这个文件时,可能会触发uvicorn的导入,在我打包时候,然后启动了多个worker出现了疯狂的reload,导致不可用。所以如果写在入口文件,实际上这start函数代码是我简化后的。还得处理app的日志配置。全写在入口文件,这代码感觉不是很简洁,入口文件main.py我个人倾向简单点。细节封装里面显得优雅。
最后按启动按钮即可