大家好,我是PmMock的产品负责人。今天想和大家聊聊我们是如何一步步把接口设计这个"老大难"问题搞定的。
做PmMock的初衷
做开发这么多年,最让我头疼的就是接口设计这件事。前后端协作时,经常遇到这样的情况:
- 后端接口文档写得不详细,前端反复确认
- 接口参数类型不对,联调时各种报错
- 版本更新了,但文档没同步,大家用的还是老版本
- 新人接手项目,看不懂接口设计思路
这些问题看似小事,但累积起来真的很影响效率。记得有一次,我们项目要上线了,结果发现前端和后端对同一个接口的理解完全不一样。前端以为返回的是用户ID字符串,后端返回的是数字对象。这种低级错误让我们整整多花了两天时间来修复。还有更离谱的,同一个接口在不同环境里的路径都不一样,开发环境用一个路径,测试环境又换了一个。文档更新也不及时,经常是代码都改了,文档还是老版本。
这些问题累积起来,让我们下定决心要做一个真正好用的接口设计工具。
PmMock接口设计的核心功能
1. 多种方式创建接口,总有一款适合你
我们团队在设计这个功能时,考虑到了不同人的使用习惯。有些人喜欢用菜单,有些人喜欢快捷键,所以我们在PmMock里提供了4种创建接口的方式:
搜索框右侧菜单 - 这个是我个人最喜欢的方式,因为搜索框本来就在那里,顺手就能点击新建 目录右侧菜单 - 我们的设计师喜欢这种方式,因为他可以把接口直接建在对应的目录下 Tab头部新建 - 程序员同事普遍喜欢这种方式,快捷方便 空白区新建按钮 - 这个是为新手准备的,最直观,一看就知道点哪里
每种方式都有它的使用场景,你可以根据自己的习惯选择。
2. 接口路径设计,原来可以这么简单
接口路径设计看似简单,但里面的门道不少。我们在PmMock里做了几个贴心的设计:
智能路径提示 - 输入路径时,系统会自动提示相关的路径结构,避免你写错层级 环境变量支持 - 不用把域名写死在路径里,通过环境管理统一配置,换环境时一键切换 Query参数自动识别 - 路径里如果有Query参数,系统会自动提取到下面的参数区域,不用重复填写
我记得有个用户反馈说,他们以前因为路径写错导致生产环境故障,用了PmMock后这种问题再也没有发生过。
3. 请求方式,不止是GET和POST
很多工具只支持GET和POST,但实际上RESTful API需要更多的请求方式。我们在PmMock里支持了所有常用的请求方式:
- GET(获取资源)
- POST(提交数据)
- PUT(更新资源)
- DELETE(删除资源)
- OPTIONS(获取支持的请求方式)
- HEAD(只返回头部信息)
- PATCH(部分更新)
每个请求方式我们都有详细的说明,新手也能快速理解什么时候该用哪种方式。
4. 参数管理,告别混乱
参数管理是接口设计中最容易出错的地方。我们在PmMock里把参数分成了几类:
Params参数 - 就是URL后面的查询参数,比如?name=张三&age=25
Path参数 - 路径里的参数,比如/users/{id}
中的id Header参数 - 请求头信息,比如token、content-type等 Body参数 - 请求体数据,支持多种格式
每种参数类型都有对应的输入界面和验证规则,再也不用担心参数格式写错了。
特别要说的是Body参数,我们支持了多种数据格式:
- form-data - 文件上传时用
- x-www-form-urlencoded - 普通表单数据
- raw - 原始数据,支持JSON、XML、文本等
系统会自动根据你选择的格式设置对应的Content-Type,不用手动配置,减少出错机会。
5. 预处理功能,让接口更智能
这个功能是我们团队花了最多时间打磨的。预处理包括前置和后置处理:
前置预处理 - 在调用接口前执行的操作,比如:
- 验证用户身份
- 检查权限
- 记录请求日志
- 参数校验
后置预处理 - 接口返回后执行的操作,比如:
- 数据格式化
- 响应校验
- 缓存处理
- 错误处理
有了预处理功能,很多重复性的工作都能自动化,大大提升了开发效率。
6. Mock数据设计,前端开发者的福音
这个功能是我们前端同事最喜欢的。接口设计好后,马上就能生成Mock数据:
JSON格式 - 支持对象和数组两种结构
- 对象:
{"name": "张三", "age": 25}
- 数组:
[{"id": 1}, {"id": 2}]
RAW格式 - 基于Mock.js规则,支持更复杂的数据生成:
- 随机姓名、手机号、邮箱
- 自定义数据格式
- 条件生成规则
前端同事再也不用等后端接口开发完成才能开始工作,设计好接口就能立即获得Mock数据进行开发。
7. 规范化字段库,团队协作的利器
这个功能解决了团队协作中的一个老大难问题。我们可以在PmMock里建立字段规范库:
常用字段统一管理 - 比如用户信息相关的字段(user_id、username、email等) 智能字段推荐 - 输入字段名时,系统会自动推荐相关的规范化字段 一键填充字段属性 - 选中规范化字段后,类型、默认值、说明等信息自动填充
这样团队成员设计接口时,字段命名和类型就能保持一致,避免了"同一个字段在不同接口里有不同命名"的问题。
8. 版本管理,再也不怕改错接口
这个功能是我们吃过亏后才加的。有一次,我们项目上线后发现接口有问题,回滚时发现不知道哪个版本是好的。
现在在PmMock里,每次修改接口都有完整的版本记录:
- 修改时间
- 修改人
- 修改内容
- 版本对比
可以随时回滚到任意历史版本,大大降低了接口修改的风险。
真实案例:效率提升300%不是吹的
上个月,一个10人开发团队的负责人给我发消息:
"用PmMock三个月,我们的接口设计效率提升了至少300%。以前设计一个接口要30分钟,现在10分钟就能搞定。最重要的是,前后端沟通成本降低了80%,基本不需要开会讨论接口细节。"
为什么能有这么大的提升?我总结了几点:
- 可视化设计 - 不用写复杂的配置文件,所见即所得
- 智能提示 - 系统会自动提示可能的错误,减少调试时间
- 团队协作 - 多人同时编辑,实时同步,减少沟通成本
- Mock数据 - 前后端可以并行开发,不用互相等待
- 版本管理 - 大胆修改,随时回滚,不用担心改错
写在最后
做PmMock这个产品,就是想解决我们自己在开发中遇到的问题。接口设计看起来简单,但要做好真的不容易。
我们相信,好的工具应该是让人用着舒服,而不是让人觉得复杂。PmMock的所有功能都是基于实际开发需求设计的,没有花里胡哨的东西,只有真正实用的功能。
如果你也在为接口设计头疼,不妨试试PmMock。希望这个工具能帮到更多的开发者,让大家能把更多时间放在创造性的工作上。
PmMock - 让接口设计更简单
- 无需编码,3分钟上手
- 可视化接口设计
- 智能参数管理
- 实时Mock数据
- 完善的版本管理
- 团队协作更高效
- 永久免费使用
体验地址:www.pmmock.com