🔍 一、什么是 EchoAPI?
EchoAPI 是一款面向现代开发者设计的 API 全生命周期管理工具,致力于简化 API 的设计、调试、测试、Mock 模拟、文档生成与团队协作流程。它具备以下核心优势:
- ✅ 完全支持离线工作,数据本地优先
- ✅ 内置自动化测试与 CI/CD 集成能力
- ✅ 支持环境变量、Mock 服务、流量录制等高级功能
- ✅ 插件化架构,可无缝集成 VS Code、JetBrains 等 IDE
- ✅ 自动生成美观、可导出的 API 文档(Markdown / HTML)
▲ EchoAPI 核心功能全景图
用了echoapi之后,你就不会想回到postman时代了!
🖥️ 二、界面概览 & 快速上手
安装完成后(官网下载),主界面清晰划分为五大区域:
▲ 左侧请求树|中央编辑区|底侧响应/测试面板|顶部环境切换|底部状态栏
✅ 基础四步:发送一个 GET 请求
- 点击 + New Request
- 选择
GET方法,输入 URL:https://jsonplaceholder.typicode.com/posts - 点击 Send
- 查看下方响应体(自动高亮 JSON、状态码、耗时)
▲ 成功获取博客列表的响应
同时也支持请求的导入
🌐 三、环境变量:一套请求,多环境切换
在开发中,常需切换 dev / test / prod 环境。EchoAPI 通过 环境变量 实现无缝适配。
1️⃣ 创建环境
// Development 环境
{
"base_url": "http://localhost:8080",
"api_version": "v1"
}
// Production 环境
{
"base_url": "https://api.example.com",
"api_version": "v2"
}
2️⃣ 在请求中使用变量
{{base_url}}/api/{{api_version}}/users
切换顶部环境下拉菜单,URL 自动重写 —— 无需手动修改!
🧪 四、自动化测试:让 API 回归验证不再手动
EchoAPI 内置基于 Postman-style pm 断言库 的测试沙箱(JavaScript),支持在每次请求后自动执行校验。
示例:验证创建用户成功
// Test Tab 中编写
pm.test("Status code is 201", () => {
pm.response.to.have.status(201);
});
pm.test("User ID exists and is number", () => {
const json = pm.response.json();
pm.expect(json).to.have.property('id');
pm.expect(json.id).to.be.a('number').and.to.be.above(0);
});
pm.test("Email matches input", () => {
const reqBody = JSON.parse(pm.request.body.raw);
const resBody = pm.response.json();
pm.expect(resBody.email).to.eql(reqBody.email);
});
▲ 发送 POST 创建资源 + 自动断言验证
💡 提示:测试脚本保存后随请求持久化,团队成员拉取项目即可复用!
接口文档写好了,支持一键分享给别人
👥 五、团队协作与 API 文档自动生成
📁 项目共享
- 创建项目 ➕ → 邀请成员(邮箱/链接)
- 所有请求、环境、测试用例实时同步
- 支持权限控制(只读 / 编辑)
📄 一键生成文档
点击 Export → API Documentation,可导出:
- ✅ Markdown(适配 GitBook / Notion)
- ✅ HTML(独立网页,支持搜索 & 折叠)
- ✅ OpenAPI/Swagger(用于对接网关或前端 SDK)
自动生成内容包含:
- 请求路径 & 方法
- Headers / Query / Body 参数说明
- 示例请求 & 响应
- 状态码解释
🎭 六、AI功能亮点
🎚️ AI自动补全
通过AI智能推荐快速完成API参数描述,解决手动填写繁琐低效的问题,确保参数文档更加规范准确。
比如,当参数名称存在但缺少对应的参数值或描述时,传统上必须逐一进行手动填写和维护,这种方式效率低下且容易出错
📊 智能解析json数据结构
智能分析JSON数据结构与字段名语义,自动为数据模型补充字段描述、示例值和默认值等关键信息,从而显著提升模型编写效率与数据定义质量
比如你吧下面的数据给echoapi
点击如下按钮
echoapi就会生成示例值、默认值和字段描述。注意:仅补全空字段;会跳过已有数据的字段。
AI搜索
告别死板的关键字匹配!使用自然语言描述需求,精准定位系统中的相关接口。真正实现智能模糊匹配——心之所想,一键即达
在右上角的搜索栏中,通过自然语言来进行搜索定位API,比如:获取所有的登录接口
✅ 结语:为什么选择 EchoAPI?
| 对比项 | Postman | EchoAPI ✅ |
|---|---|---|
| 离线可用性 | ❌ 需登录同步 | ✅ 完全离线 |
| 插件轻量化 | ⚠️ 较重 | ✅ 轻量插件生态 |
| 文档导出质量 | 一般 | ✅ 专业级 Markdown/HTML |
| Mock 灵活性 | 基础支持 | ✅ 支持脚本化动态响应 |
| 国产化/私有部署 | 有限 | ✅ 支持企业私有化部署 |
🌟 推荐场景:敏捷团队、微服务架构、前后端分离项目、需要高自动化覆盖率的中大型系统。