VSCode+CodeGeeX自动生成Restful API实战指南

几个关键结论：在VSCode中使用CodeGeeX自动生成API接口，确实能大幅减少重复、模板化的代码编写。但工具再强，也需掌握其调用技巧——不是随便输入几句指令就能完美运行。

设想你正在赶一个API接口，要求符合RESTful规范，能直接启动运行。手动编写Flask或FastAPI的路由、请求解析、状态码返回，这些重复劳动做过几次就深知其枯燥。CodeGeeX正是为此而生。

具体步骤？往下看。

确认 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这三行。缺一不可——缺少任何一行，启动即报错，排查更耗时。

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

新建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——那会将本地服务暴露在公网，存在安全风险。

验证接口是否符合 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资源创建的正确语义。

整个流程走完，你实际上用自然语言“描述”出一个可直接运行的API接口，且完全符合规范。这才是工具应有的价值。