创建最简单FastApi的项目

一、依赖导入

pip install fastapi
用于运行项目的容器
pip install uvicorn

二、最简单的接口

1 导入相关的包

from fastapi import FastAPI
import uvicorn

2 创建一个fastapi应用

app = FastAPI()

3 写一个简单的接口

@app.get("/")
def index():
    return "hello world"

4 在uvicorn容器中运行

if __name__ == '__main__':
    uvicorn.run(app)

5 测试接口

直接进入http://127.0.0.1:8000 

三、源代码

from fastapi import FastAPI
import uvicorn
app = FastAPI()

@app.get("/")
def index():
    return "hello world"

if __name__ == '__main__':
    uvicorn.run(app)

源代码地址:天才奇男子/学习笔记

<think>嗯,用户现在想了解怎么用PyCharm创建FastAPI项目。之前他们问过Django和FastAPI的对比,现在可能已经决定用FastAPI了,所以需要具体的操作指导。首先,我需要回忆一下PyCharm的步骤,确保自己没错。 用户可能是开发者,有一定Python基础,但可能对FastAPI不太熟悉。他们可能希望有一个详细的步骤指南,包括环境设置、依赖安装和示例代码。可能需要注意PyCharm的版本,不同版本界面可能不同,但大体步骤应该类似。 首先,创建项目的时候,PyCharm通常会使用虚拟环境,所以需要提醒用户检查Python解释器。然后安装FastAPI和uvicorn,这两个是基础依赖。可能还需要提到其他常用库,比如SQLAlchemy或者Pydantic,但用户的问题主要是创建项目,所以基础就够了。 接下来,创建main.py文件,写一个简单的FastAPI应用示例。这部分需要确保代码正确,比如@app.get装饰器和uvicorn的启动命令。要提醒用户运行的方式,可能有人不知道uvicorn的命令行参数,所以给出具体的示例。 另外,用户可能想测试API是否正常运行,所以需要说明如何访问/docs和测试端点。可能还要提到自动生成的Swagger文档,这是FastAPI一个优势,可以强调这一点。 可能的问题:用户的环境配置有问题,比如Python路径不对,或者依赖安装失败。这时候需要建议他们检查解释器设置,或者用终端手动安装。另外,如果用户用的是社区版PyCharm,可能需要手动配置运行配置,而专业版可能更自动。 还要考虑用户是否需要进一步的扩展,比如添加路由、数据库连接,或者部署建议,但当前问题集中在创建项目,所以可能点到为止,或者简要提及后续步骤。 最后,确保步骤清晰,分点说明,避免信息过载。使用代码块和具体命令,方便用户复制粘贴。可能还需要提醒常见的错误,比如端口被占用,或者忘记安装uvicorn。</think>以下是使用PyCharm创建FastAPI项目的分步指南: --- ### 一、环境准备 1. **安装PyCharm** - 推荐使用**专业版**(支持Web开发工具链),社区版也可用但需手动配置。 2. **Python版本** - 确保已安装Python 3.7+(FastAPI依赖现代Python特性)。 --- ### 二、创建FastAPI项目 #### 步骤1:新建项目 1. 打开PyCharm → `File` → `New Project` 2. 选择项目路径,设置**虚拟环境**: ```plaintext Location: /your/project/path Python Interpreter: 选择或新建虚拟环境(推荐venv) ``` #### 步骤2:安装依赖 1. 打开PyCharm终端(`Terminal`标签页) 2. 安装核心包: ```bash pip install fastapi uvicorn[standard] ``` - `uvicorn[standard]`:含高性能ASGI服务器及WebSocket支持 - 可选扩展:`pip install python-multipart pydantic-settings`(表单/配置管理) --- ### 三、编写示例代码 #### 创建主文件 1. 右键项目根目录 → `New` → `Python File` → 命名如`main.py` 2. 写入基础代码: ```python from fastapi import FastAPI app = FastAPI() @app.get("/") async def root(): return {"message": "Hello FastAPI"} @app.get("/items/{item_id}") def read_item(item_id: int, q: str = None): return {"item_id": item_id, "q": q} ``` --- ### 四、运行与测试 #### 方式1:命令行启动 1. 在终端执行: ```bash uvicorn main:app --reload ``` - `--reload`:开发模式(代码修改后自动重启) - 默认访问地址:`http://127.0.0.1:8000` #### 方式2:PyCharm配置运行 1. 点击右上角运行配置 → `Edit Configurations` → `+` → `Python` 2. 配置参数: ```plaintext Script path: 选择main.py Parameters: main:app --reload Python interpreter: 确保选中项目虚拟环境 ``` 3. 点击运行按钮启动服务 --- ### 五、验证API 1. **访问根路径**:浏览器打开`http://localhost:8000` → 应返回`{"message":"Hello FastAPI"}` 2. **交互文档**:访问`http://localhost:8000/docs` → 自动生成的Swagger UI界面 3. **测试端点**:在/docs页面直接调用`/items/{item_id}`接口 --- ### 六、项目扩展建议 | 需求 | 推荐方案 | |---------------------|----------------------------------| | **数据库集成** | SQLAlchemy + Alembic(迁移工具) | | **身份验证** | OAuth2 + JWT(使用`passlib`库) | | **API文档增强** | 添加OpenAPI元数据描述 | | **部署生产环境** | Gunicorn + Uvicorn Worker | --- ### 常见问题排查 1. **端口占用**: ```bash uvicorn main:app --reload --port 8001 # 更换端口 ``` 2. **依赖冲突**:使用`pip freeze > requirements.txt`导出依赖清单 3. **文档未生成**:检查路由装饰器是否正确使用`@app.get()`/`@app.post()` --- 通过以上步骤,即可快速搭建一个功能完备的FastAPI项目。如果需要更复杂的架构(如多路由分层),可创建`routers`目录并按模块拆分代码。
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值