产品经理关于接口那些事儿

产品经理遇到接口的问题如何去处理?点这里!点这里!点这里!

一、接口是啥?

API(Application Programming Interface)即应用程序接口。可以认为 API 是一个软件组件或是一个 Web 服务与外界进行的交互的接口。从另一个角度来说,API是一套协议,规定了我们与外界的沟通方式:如何发送请求和接收响应。

二、知识剖析

接口分为四部分:

1、方法:新增(post) 修改(put) 删除(delete) 获取(get)

2、格式:以/a开头,如果需要登录才能调用的接口后面需要加/u(如新增、修改;前台的用户个人信息,资金信息等),即:/a/u;中间一般放表名或者能表达这个接口的单词;get方法,如果是后台通过搜索查询列表,那么以/search结尾,如果是前台的查询列表,以/list结尾。

3、请求参数和返回参数,都分为5列:字段、说明、类型、备注、是否必填

江苏快3开奖结果 字段是类的属性;说明是中文释义;类型是属性类型,;备注是一些解释,或者可以写一下例子,比如负责json结构的情况,最好写上例子(这里不是产品写),好让前端能更好理解;是否必填是字段的是否必填。

4、返回参数结构有几种情况:1、如果只返回接口调用成功还是失败(如新增、删除、修改等),则只有一个结构体:code和message两个参数;2、如果要返回某些参数,则有两个结构体:1是code/mesage/data,2是data里写返回的参数,data是object类型;3、如果要返回列表,那么有三个结构体,1是code/mesage/data,data是object,里面放置page/size/total/totalPage/list 5个参数,其中list是Arrary类型,list里放object,object里是具体的参数。(产品了解即可)

三、接口设计原则

1.充分理由:不是随便一个功能就要有个接口,也不是随便一个需求就要加个接口。每新建一个接口,就要有充分的理由和考虑,无意义的接口不仅增加了维护的难度,更重要是对于程序的可控性的大大降低,接口也会十分臃肿。

2.职责明确:一个接口只负责一个业务功能,比如查询会员,但不要在查询会员的同时还有修改权限等类似的其他业务功能,应该分成两个接口做。

3.高内聚低耦合:一个接口要包含完整的业务功能,而不同接口之间的业务关联要尽可能的小。

4.分析角度明确:设计接口分析的角度要统一明确。否则会造成接口结构的混乱。

5。入参格式统一:所有接口的参数格式要求及风格要统一,不要一个接口参数是逗号分隔,另一个就是数组;不要一个接口日期参数是x年x月x日风格,另一个就是x-x-x。

6。状态及消息:提供必要的接口调用状态信息。调用是否成功?如果失败,那么失败的原因是什么。这些必要的信息必须要告诉给客户端。

7。控制数据量:一个接口返回不应该包含过多的数据量,过多的数据量不仅处理复杂,对数据传输的压力也非常大,会导致客户端反应缓慢。过多的数据量很多时候都是接口划分不明确。

0条评论 添加新讨论

登录后参与讨论
Ctrl+Enter 发表