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

先说几个核心判断：用CodeGeeX在VSCode里生成API接口，确实能把那些重复的、模板化的代码活儿省掉大半。但工具再好，也得摸清它的脾气——不是随便敲几句指令就能跑通的。

想象一下，你正赶着交付一个API接口，要求符合RESTful规范，能直接跑起来。从零手敲Flask或FastAPI的路由、请求解析、状态码返回，这些活儿干过几次就知道有多无聊了。CodeGeeX就是用来干这事儿的。

那么，具体怎么操作？我们一步步来。

确认 CodeGeeX 插件已就绪

打开VSCode，去扩展商店搜索CodeGeeX，点击安装，重启编辑器。左侧或右侧边栏会出现CodeGeeX的图标——如果没看到，按

，输入“View: Toggle Sidebar”就能恢复。点击图标完成登录，新用户每天有20次免费调用额度，够你折腾一阵子了。

有一点容易忽略：确保项目根目录下的

。不然生成的代码可能缺import语句，或者跑起来直接报ModuleNotFoundError，那可就尴尬了。

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

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

把光标放到空行，按下

进入交互模式，然后输入提示词：

“生成一个 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，右键它，选择“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接口，而且完全符合规范。这才是工具该有的样子。