如何在 VSCode 中使用 CodeGeeX 自动生成符合 Restful 规范的 API

CodeGeeX可在VSCode中一键生成符合RESTful规范的FastAPI接口：通过自然语言指令生成含Pydantic校验的GET/POST路由，自动补全requirements.txt与Uvicorn启动脚本，并支持Swagger验证。

你需要在 VSCode 里快速产出一个能直接跑起来、符合 RESTful 设计规范的 API 接口，而不是从零手敲 Flask 或 FastAPI 的路由、请求解析、状态码返回这些重复逻辑。

确认 CodeGeeX 插件已就绪

打开 VSCode → 扩展商店搜索 CodeGeeX → 点击安装 → 重启编辑器 → 左侧或右侧边栏出现 CodeGeeX 图标（若未见，按 Ctrl+Shift+P 输入 “View: Toggle Sidebar” 恢复）→ 点击图标完成登录（新用户每日免费调用额度为 20 次）。

确保当前项目根目录下已有 Python 解释器被正确识别，否则生成的代码可能缺失 import 或报 ModuleNotFoundError。

用自然语言指令生成完整 FastAPI 接口

新建一个 main.py 文件，在顶部写一行注释说明用途，例如：# 用于暴露商品管理API：支持GET /items获取列表，POST /items创建新商品。

将光标置于空行，按下 Ctrl+Enter 进入交互模式，输入以下提示词：

“生成一个 FastAPI 应用：提供 GET /items 返回 JSON 列表，POST /items 接收 name（str, 非空）、price（float, >0）字段，使用 Pydantic v2 模型校验，成功时返回 201，校验失败返回 422。”

等待右侧候选框出现 → 点击 Use Code 插入生成结果 → 检查是否包含 from fastapi import FastAPI、BaseModel 定义、@app.get/@app.post 装饰器及 response_model 声明。

补全依赖与启动脚本

方法一：自动生成 requirements.txt

新建空文件 requirements.txt → 右键该文件 → 选择 “CodeGeeX → Generate dependencies” → 确认输出含 fastapi==0.115.0、pydantic==2.9.2、uvicorn==0.32.0 三行，【缺一不可，否则 uvicorn 启动会报错】。

方法二：一键生成启动脚本

新建 run.sh（macOS/Linux）或 run.bat（Windows）→ 光标置入 → 输入提示词：“生成启动 Uvicorn 的脚本，绑定 127.0.0.1:8000，启用 reload 模式” → 插入后检查命令是否为 uvicorn main:app --host 127.0.0.1 --port 8000 --reload，【严禁使用 0.0.0.0 替代 127.0.0.1，防止本地服务意外暴露】。

验证接口是否符合 RESTful 规范

第一步：终端执行 pip install -r requirements.txt → 等待安装完成。

第二步：运行 bash run.sh 或双击 run.bat 启动服务。

第三步：打开浏览器访问 http://127.0.0.1:8000/docs → 查看自动生成的 Swagger UI 页面 → 确认 GET /items 和 POST /items 两个端点存在 → 点击 Try it out → 对 POST 发送如下 JSON：

{"name": "Wireless Mouse", "price": 29.99}

第四步：观察响应状态码是否为 201 Created，响应体是否含完整对象字段，且 Location 头未缺失 → 符合 RESTful 对资源创建的语义要求。