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

陌墨小哥_1962

陌墨小哥_1962

2026-06-20

152人浏览

原创

codegeex可在vscode中一键生成符合restful规范的fastapi接口:通过自然语言指令生成含pydantic校验的get/post路由,自动补全requirements.txt与uvicorn启动脚本,并支持swagger验证。

☞☞☞AI 智能聊天, 问答助手, AI 智能搜索, 多模态理解力帮你轻松跨越从0到1的创作门槛☜☜☜

如何在 vscode 中利用 codegeex 自动生成符合 restful 规范的 api

你需要在 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

FastAPI Flask Proxy
FastAPI Flask Proxy

FastAPI + Flask 混合部署最佳实践,解决路由定义、API 代理等常见问题,适用于同时运行 FastAPI API 与 Flask 前端的场景。

下载

新建空文件 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 对资源创建的语义要求。

大量免费API接口:立即使用
涵盖生活服务API、金融科技API、企业工商API、等相关的API接口服务。免费API接口可安全、合规地连接上下游,为数据API应用能力赋能!

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
CodeGeeX下载安装教程合集
CodeGeeX下载安装教程合集

提供CodeGeeX最新版下载地址、历史版本下载、VS Code安装教程、JetBrains安装教程及常见安装问题解决方案。

2026.06.16

596

15

CodeGeeX代码生成教程合集
CodeGeeX代码生成教程合集

汇总CodeGeeX代码生成技巧、代码补全教程、单元测试生成、代码优化及实际开发案例。

2026.06.16

577

31

CodeGeeX大模型教程合集
CodeGeeX大模型教程合集

详细介绍CodeGeeX底层模型能力、多语言代码生成效果、模型架构及应用场景

2026.06.16

136

10

CodeGeeX VSCode插件教程大全
CodeGeeX VSCode插件教程大全

专注CodeGeeX VS Code插件的安装配置、功能使用、快捷键及开发实践。

2026.06.16

650

15

Python uv使用教程
Python uv使用教程

本专题汇总了 Python uv 使用教程与高效使用指南,从 uv 安装配置、常用命令到虚拟环境、依赖管理与项目打包,系统讲解如何用 uv 替代 pip 与 poetry,全面提升 Python 项目开发效率,助你快速上手这一现代化包管理工具,打造干净高效的 Python 工作流。

2026.10.15

0

15

剧云AI短剧创作教程合集
剧云AI短剧创作教程合集

本专题聚焦剧云AI短剧创作,讲解从短剧灵感、梗概、全局大纲到分集、分场和正文的完整流程及节奏设计方法。

2026.10.14

0

15

剧云AI剧本创作零基础入门
剧云AI剧本创作零基础入门

本专题系统讲解剧云AI剧本创作流程,涵盖灵感、梗概、大纲、分场与正文生成,帮助新手快速完成首个中文剧本项目。

2026.10.14

0

14

VibeKnow文档转视频操作指南
VibeKnow文档转视频操作指南

本专题讲解VibeKnow上传Word、TXT、Markdown等材料生成视频的方法,覆盖内容解析、脚本组织、画面生成与成片检查。

2026.10.14

0

15

VibeKnow知识视频制作与导出详解
VibeKnow知识视频制作与导出详解

本专题整理VibeKnow从注册、素材上传、AI生成到预览导出的完整操作,帮助新手快速制作第一条知识讲解视频。

2026.10.14

0

13

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程