提供给外部调用的接口设计原则
发布时间：2020-12-16 21:55:05 所属栏目：安全 来源：网络整理
导读：1、接口入参、出参和接口名应拥有统一的命名规范，要做到 见名知意。 2、不要做大而全的接口，要尽量保持接口的功能单一 好处：这样有利于接口调试、改造升级和维护 3、接口出参应含有接口调用结果信息(code 和 message)字段 4、接口出参应对同类型（单条，
|
1、接口入参、出参和接口名应拥有统一的命名规范，要做到见名知意。 2、不要做大而全的接口，要尽量保持接口的功能单一 好处：这样有利于接口调试、改造升级和维护 3、接口出参应含有接口调用结果信息(code 和 message)字段4、接口出参应对同类型（单条，多条，分页）的数据有固定相同的格式 ?好处：3和4条 可以方便接口使用者封装接口的调用 5、接口出参要使用像json或xml这种平台无关的数据格式好处：json和xml使接口也具有了良好的跨平台特性 ? ? json与js的完美融合，更利于前端开发 该接口设计原则针对webservice接口和fix接口 （编辑：李大同） 【声明】本站内容均来自网络，其相关言论仅代表作者个人观点，不代表本站立场。若无意侵犯到您的权利，请及时与联系站长删除相关内容! |