产品经理--接口
2019-03-18 16:30:48 0 举报AI智能生成
产品经理-接口相关概述
作者其他创作
大纲/内容
什么是接口
API，全称是ApplicationProgramming Interface，即应用程序编程接口，我们日常中习惯简称为“接口”。
接口是一些预先定义的函数，目的是提供应用程序与开发人员基于某软件或硬件的以访问一组例程的能力，而又无需访问源码，或理解内部工作机制的细节。
数据接口是指前端（客户端）与服务端进行数据传输和交互的数据协议，数据接口是一种数据交换的标准，扮演的是信息传递者的角色。
接口类型
JSF（杰夫接口）
服务端内部调用的接口，使用环境局限于内网
http接口
网关接口，对外提供公共服务
前端&客户端（HTML/CSS样式+JS逻辑）--http接口--jsf接口--服务端
接口属性
接口地址及方法
请求方法
请求参数
返回参数
接口文档
接口标题
接口版本
接口描述
简单描述接口的逻辑和作用
配置环境
地址及方法
地址
接口的正式url和接口测试的url，需求方通过调用接口url，获取响应内容
方法
获取不同内容的方法名，一个接口可有多个方法。
类型
POST/GET
接口最常见的请求方法为GET和POST两种方式，即读接口和写接口。通过这两种方式，实现对数据的增删查改。增删改本质都是写的动作。
PUT/DETETE
请求参数
业务参数
是否必传
必传
非必传
字段类型
字段长度
PS：请求的数据会附在URL之后，以?分割URL和传输数据，参数之间以&相连，如：xxxx.ha?userid=PMnote&userpws=123456&version=6.0。
密钥
appID/secret
管理接口调用权限，区分调用方，权责明确
返回参数
业务参数
普通字段
文本
数字
复合型对象
调用结果
isSuccess
错误码
错误码对照表
错误码文案描述
实例
模拟调用场景的代码实例，便于研发人员快速掌握
接口部署
上线特点
业务逻辑耦合，牵一发动全身
服务器多，上线时间慢
负载能力
调用峰值
负载容量
性能
相应时间（TP999/TP99/TP90）
加载数量
超时时间
针对网络异常等情况下的调用处理
可能遇到的坑
提供方
不设置appid，无法区分调用渠道
修改时未通知调用方
尤其是错误码
上线时配置文件不同步
多项目同时上线，相互影响
敏感字段未加密
接口文档格式
pdf，不可修改，可追踪
调用方
未评估调用峰值和容量，造成负载超限
调用异常未同步前端做提示or提示文不对题
未设置调用超时
前端上线与接口上线的时间关系未同步好
扩展阅读
http://www.woshipm.com/pd/200895.html
http://www.woshipm.com/pmd/148480.html
http://www.woshipm.com/pd/706047.html
0 条评论
下一页
