前语
这是一项繁琐且乏味的填充式工作,但是却是说清楚每个字段业务表达必不可少的。尤其是同一个字段名称在不同业务场景下出现不同含义的时候就很有必要了。甚至有同一种业务表达用了多个不同字段名称的情况。这些在实际开发过程中都很常见,所以这项工作很需要对业务场景的熟悉和理解,尤其是全面业务场景的准确理解。很多时候后端、前端在理解上不一致导致开发出现了歧义,但又由于字段名称的繁多和一些其他方面导致说不清楚,讲不明白而且很多时候都是两套不同的话语名称,理解上很难达成一致。如果再加上开发人员经验不是那么丰富。那开发团队气氛有有那么一点点紧张了
路径:顶部菜单栏–》参数描述库按钮–》弹出参数描述库对话框
- 通过自定义参数描述库,可以将项目用到的大量参数进行预注释
- 导入参数描述功能,将数据库定义的字段注释快速导入到APIPOST的参数描述库中
点击“导入Key-Value/Json参数描述”如下图:
导出参数描述:
导出Key-value参数描述:
导出 Raw-Json参数描述,如下图:
- 已定义的参数,我们可以直接快速导入参数描述
点击“提取字段和描述”
产品推荐
推荐理由
postman在国内使用已经越来越困难:
1、登录问题严重
2、Mock功能服务基本没法使用
3、版本更新功能已很匮乏
4、某些外力因素导致postman以后能否使用风险较大
出于以上考虑因此笔者自己开发了一款api调试开发工具SmartApi,满足基本日常开发调试api需求
官网地址SmartApi
http://www.smartapi.site/
是的,兄弟们,我还是建立了自己的官网!需要下载的大佬直接去官网下载就可以了蛤,顺便看看官网介绍
看下面的简单的