【接口工具ApiPost】参数描述库(8)
前语
这是一项繁琐且乏味的填充式工作,但是却是说清楚每个字段业务表达必不可少的。尤其是同一个字段名称在不同业务场景下出现不同含义的时候就很有必要了。甚至有同一种业务表达用了多个不同字段名称的情况。这些在实际开发过程中都很常见,所以这项工作很需要对业务场景的熟悉和理解,尤其是全面业务场景的准确理解。很多时候后端、前端在理解上不一致导致开发出现了歧义,但又由于字段名称的繁多和一些其他方面导致说不清楚,讲不明白而且很多时候都是两套不同的话语名称,理解上很难达成一致。如果再加上开发人员经验不是那么丰富。那开发团队气氛有有那么一点点紧张了
路径:顶部菜单栏–》参数描述库按钮–》弹出参数描述库对话框
- 通过自定义参数描述库,可以将项目用到的大量参数进行预注释
- 导入参数描述功能,将数据库定义的字段注释快速导入到APIPOST的参数描述库中
点击“导入Key-Value/Json参数描述”如下图:
导出参数描述:
导出Key-value参数描述:
导出 Raw-Json参数描述,如下图:
- 已定义的参数,我们可以直接快速导入参数描述
点击“提取字段和描述”
自研产品推荐
历时一年半多开发终于smartApi-v1.0.0版本在2023-09-15晚十点正式上线
smartApi是一款对标国外的postman的api调试开发工具,由于开发人力就作者一个所以人力有限,因此v1.0.0版本功能进行精简,大功能项有:
- api参数填写
- api请求响应数据展示
- PDF形式的分享文档
- Mock本地化解决方案
- api列表数据本地化处理
- 再加上UI方面的打磨
为了更好服务大家把之前的公众号和软件激活结合,如有疑问请大家反馈到公众号即可,下个版本30%以上的更新会来自公众号的反馈。
嗯!先解释不上服务端原因,API调试工具的绝大多数时候就是一个数据模型、数据处理、数据模型理解共识的问题解决工具,所以作者结合自己十多年开发使用的一些痛点来打造的,再加上服务端开发一般是面向企业的,作者目前没有精力和时间去打造企业服务。再加上没有资金投入所以服务端开发会滞后,至于什么时候会进行开发,这个要看募资情况和用户反馈综合考虑。虽然目前国内有些比较知名的api工具了,但作者使用后还是觉得和实际使用场景不符。如果有相关吐槽也可以在作者的公众号里反馈蛤!
下面是一段smartApi使用介绍: