VSCode EasyAPI
VSCode EasyAPI 是一个强大的 Visual Studio Code 扩展,帮助开发者从代码注释自动生成 API 文档并发布到 YApi 平台。
主要功能
- 一键导出 API 文档:从代码注释直接生成并上传 API 文档到 YApi
- 支持多种语言:支持 JavaScript、TypeScript 和 Java 代码中的 API 注释解析
- 智能 API 更新:自动检测并更新已存在的 API 接口,避免重复创建
- 支持选择性导出:可以导出整个文件或只导出选定部分的 API
- 自定义分类管理:支持在 YApi 中创建和管理 API 分类
- 灵活的配置选项:支持配置多个 YApi 服务器和项目
安装
在 VS Code 扩展市场中搜索 "VSCode EasyAPI" 并安装,或者通过命令面板 (Ctrl+P) 运行以下命令:
ext install liudaoyang.vscode-easyapi
使用方法
配置 YApi 服务器和项目
首次使用前,需要配置 YApi 服务器地址和项目令牌:
- 通过命令面板 (Ctrl+Shift+P) 运行
Set YApi Server and Project Token 命令
- 输入 YApi 服务器地址(例如:
https://yapi.example.com )
- 输入项目名称和对应的项目令牌
导出 API 文档
导出当前文件
- 打开包含 API 注释的代码文件
- 右键单击编辑器,选择
Export to YApi
- 选择目标 YApi 项目和分类
- 扩展将自动解析代码中的 API 注释并上传到 YApi
导出选中的代码
- 在编辑器中选择包含 API 注释的代码片段
- 右键单击选中的代码,选择
Export Selected to YApi
- 选择目标 YApi 项目和分类
- 扩展将只解析并上传选中部分的 API
创建 YApi 分类
- 右键单击编辑器,选择
Create YApi Category
- 输入新分类名称
- 选择目标 YApi 项目
- 扩展将在 YApi 中创建新分类
设置日志级别
通过命令面板运行 Set Log Level for EasyAPI 命令,可以设置以下日志级别:
- DEBUG:显示所有调试信息
- INFO:显示常规信息(默认)
- WARN:只显示警告和错误
- ERROR:只显示错误信息
支持的注释格式
JavaScript/TypeScript
支持 JSDoc 风格的注释格式:
/**
* @api {get} /user/:id 获取用户信息
* @apiName GetUser
* @apiGroup User
* @apiDescription 根据用户ID获取用户详细信息
*
* @apiParam {String} id 用户ID
*
* @apiSuccess {Object} data 用户信息
* @apiSuccess {String} data.id 用户ID
* @apiSuccess {String} data.name 用户名
* @apiSuccess {Number} data.age 年龄
*
* @apiError {Object} error 错误信息
* @apiError {String} error.message 错误消息
*/
Java
支持 JavaDoc 风格的注释格式:
/**
* @api {post} /user/create 创建用户
* @apiName CreateUser
* @apiGroup User
* @apiDescription 创建新用户
*
* @apiParam {String} name 用户名
* @apiParam {String} email 邮箱
* @apiParam {String} password 密码
*
* @apiSuccess {Object} data 用户信息
* @apiSuccess {String} data.id 用户ID
* @apiSuccess {String} data.name 用户名
*
* @apiError {Object} error 错误信息
*/
配置选项
在 VS Code 设置中,可以配置以下选项:
- vscode-easyapi.yapiServer:YApi 服务器地址
- vscode-easyapi.projectTokens:YApi 项目令牌,格式为:
{"项目名称": "token"}
- vscode-easyapi.yapiProjects:YApi 项目配置,格式为:
{"项目名称": {"server": "服务器地址", "token": "项目token"}}
- vscode-easyapi.logLevel:日志级别,可选值:"DEBUG", "INFO", "WARN", "ERROR"
最近更新
版本 1.0.1
- 修复接口匹配逻辑,优化接口已存在判断算法
- 改进问题反馈渠道,提供更多联系方式
- 优化包大小,减少不必要的文件
版本 1.0.0
- 改进接口更新逻辑,使用
/api/interface/up 接口更新已存在的 API
- 优化接口匹配算法,支持不区分大小写的路径匹配
- 修复接口在不同分类下更新的问题
- 通知消息优化,成功创建分类的通知将在 3 秒后自动消失
问题反馈
如果您在使用过程中遇到任何问题,或者有功能建议,请通过以下方式联系:
- 联系开发者:liudaoyang
- 邮箱:[yangmenglong@kanzhun.com]
所有反馈和建议将帮助我们不断改进此扩展。
许可证
MIT
| |