开发接口文档_产品经理必懂的接口文档撰写方式
做产品经理的难免会调研各式各样的第三方需求能力。以满足产品提供用户的市场价值,比如第三方登录、图像识别、风控算法,都有专注的服务厂商。
企业无需自己花时间和精力投入在具有较高技术壁垒或时间成本的需求上。简单称之为:“就算自己做也做不好”
同样接口也允许数据产生了流转,可以让部门之间、企业之间有权限、数据共享的意义。
学会看API接口文档,是一项产品经理的基本功。
接口文档包含什么维度?
▲ 接口文档范围
有了接口文档,我们可以知道功能的逻辑、功能的边界、和接入的条件。比如要
比如有万年历的接口文档描述了接口的传输数据是当天详情。
▲ 万年历的能力描述
每家公司每个项目组的文档都可能不一样。一般是项目成员的前后端开发工程师定义接口,接口文档需要不断维护。
所以经常有不懂开发的老板和产品经理说,某某后台同学你把后台功能给其他部门直接用、或者某某客户端你把你的app直接给某某部门后台用。
“开发的拳头就捏紧了。”
在一家公司不同项目下,接口仍然有规范不一致的情况,更何况公司之间的数据交流。这也是为什么有产品经理的公司,都不会选择外包。外包开发意味着后期维护在接口、规范上都是不清楚的,难以搞清楚对方的撰写代码思路和潜在问题。
1.接口方法
新增post
修改put
删除(delete)
获取(get)
通过上面4个定义接口的权限。
2.URI定义
以/a开头,如果你的账户涉及到需要登录权限、比如我们的微信开放平台、第三方单点登录,则需要/u。如果是通过后台要查询数据库列表,则以/search结尾。如果是查询前台的列表则以/list结婚
3.请求参数和返回参数
两个类型参数都分为5列:字段、说明、类型、备注、是否必填。
▲ 接口的参数案例
字段:类的属性
说明:中文解释字段什么意思
类:属性类型
有string(字符串)、number(整数)、object(对象)、arrar(数组)四种类型。
备注:接口的能力或逻辑解释,或者可以写一下列子,有的情况有列子会让开发人员看得懂一些。比如json
返回参数:返回参数和产品经理的异常是非常相关的。比如
- 只会返回接口调用成功或失败
- 返回某些参数
- 返回列表
上面3种返回形式都包含内容有区别。
第一种
新增、删除、修改等,只需要一个结果即可。
第二种
结构体有2个,第一个是code/mesaeg/dat ,第二个是data里写返回的参数,data是object类型
第三种
过于偏向开发知识,就不再叙述。
互联网企业要开放能力给其公司或开发者使用,就需要创建接口和定制接口规范。
常见的产品形态有开放平台这类形式。通过开发者注册账户,创建单独秘钥,再提供接口允许开发者获取能力。
如下是喜马拉雅的开放平台下提供的音频能力的SDK、API接入文档。在接口文档里面有前面提到的规范内容。
▲ 喜马拉雅接口文档
请求后会有响应。在代码层面会有如下的显示规则
serid Long 用户ID
usernick String 用户登录名
sessionkey String 用户会话key
示例
请求
“XXXX”
响应
{“usersession11”:
{“userid”:”12512313”,
“usernck”:” name1 “,
”sessionkey”:”2122323232332435353”,
}}
响应有结果,并且显示调用成功则表示接口调通。
第一:请求
说明请求地址,告诉如何调用接口
第二:调用秘钥
比如喜马拉雅要求申请秘钥,走开放平台账户协议进行注册。
第三:API测试
接通后倒地显示什么结果,如何知道接口是否接通?就需要在接口文档里面知道成功的参数
▲ 请求测试
同理可以在微信开放平台上可以看到
▲ 微信开放平台的接口文档描述
多个接口文档组成的接口目录让产品经理和开发者快速查询功能点,以集成到自己的产品中。所以产品经理做第三方能力调研,最多时间的就是去看对方的接口文档就
包括对接口的描述,比如下图是是地理位置获取。可以看到在该接口下,是智能收到应用没有停止下的消息接收。
▲ 微信公众平台提供位置信息的接口
以上就是本次分享,今天的分享就在这里。
开发接口文档_产品经理必懂的接口文档撰写方式相关推荐
- java产品经理_产品经理必懂的技术那点事儿:成为全栈产品经理
资料目录: 1 产品思维与技术思维 1 1.1 产品经理为什么要懂技术 1 1.2 产品经理和工程师分别是干什么的 3 1.3 产品设计中需要注意的技术边界 5 1.4 工程师的 ...
- 对接接口文档_产品经理所理解的接口
本文目标用户: 1.在产品设计中遇到有关于接口对接的经历,但是之前没有接触过类似对接. 2.想了解产品眼中的接口到底是什么东西? 3.对于已经明确了解并有相关对接的产品大佬们,欢迎你们指点. 一.AP ...
- E站账号cookie分享_产品经理必懂知识点—cookie和session
作为一个产品经理,如果不了解cookie和session很难设计好产品,尤其对于网站产品经理而言,cookie和session是一个必须要懂的知识点.如果在中大型企业做产品经理,这个cookie和se ...
- 前端H5怎么切换语言_第一章 产品经理必懂的前端技术- 上
产品经理为什么要懂一些前端技术? 当前端H5工程师说CSS时,你是否知道他在表达什么? 当andriod工程师说这个文本要用TextView时,你是否明白TextView是什么? 当ios工程师说这个 ...
- 产品经理必懂的技术那点事儿 pdf_培养一个合格的产品经理需要多少钱?
过去这几年,有大量产品经理进入到互联网行业.初阶产品岗位竞争激烈,但高阶产品岗位却很难招人. 说直白点,能独立扛事的产品经理是很少的. 什么叫独立扛事? 就是能基于公司战略和业务目标,制定对应的产品方 ...
- AI产品经理必懂5种技术关系
http://www.woshipm.com/pmd/1629952.html AI产品经理在对于AI技术上都会有迷茫和焦虑,那么AI产品经理需要了解技术关系有哪些呢? 产品经理面临对AI技术都有迷茫 ...
- 产品经理必懂的技术那点事儿 pdf_产品经理10大基础技能(5):读透神经网络和机器学习...
本篇先介绍许多热门的行业均在产生AI产品经理岗位的需求,再详细介绍AI产品经理必懂的AI技能,接着撰写什么是神经网络?什么是机器学习?最后用一个案例详细拆解AI产品经理如何用机器视觉识别手写字体的整体 ...
- 笔记 | 产品经理必懂的技术(三)
1.产品思维与技术思维 1.1 产品经理为什么要懂技术 思维模式差异: 在实际工作做不难发现,当产品经理与工程师就某一个具体问题进行讨论时,双方站在各自角度就问题进行分析和讨论,固有知识结构的差异导致 ...
- 图书馆的uml概念类图是什么_产品经理必学UML:类图
本篇文章主要介绍了UML静态视图中的类图,包括类图的概念.用途及相关元素,供大家一起参考和学习. UML(Unified Modeling Language)又称统一建模语言或标准建模语言,可以看做用 ...
最新文章
- FMDatabase常见的几个操作
- 手机能上网,电脑联不上网
- html5+css3基础教程收集
- oracle学习笔记系列------oracle 基本操作之表的增删改查
- 如何用VS2005制作Web安装程序
- Javascript中document.execCommand()的用法
- 网页长截图工具_Mac系统如何轻松实现网页长截图功能
- 如何开发一个完整的JavaScript组件
- 复杂网络分析工具及其比较(转)
- Python金融数据挖掘 第11章 复习思考题3 某年各省级行政区环境污染状况的统计数据(已经过标准化处理),现采用K均值聚类方法,编写Python程序将省级行政区分成4类。
- 【vuejs】有关UI框架“ydui”中的倒计时组件的使用
- 谷尼国际软件-企业竞争情报系统
- 程序员”脑筋急转弯”
- 鸿蒙开放beta版有什么用,鸿蒙2.0beta活动有什么内容 鸿蒙2.0 Beta手机版什么时候发布...
- windows server 2016添加开机启动项
- Opencv获取电脑摄像头抓拍的信息,
- 贪心算法or背包问题
- 芯片组成、制作、涉及到的产业链
- Android面试必备知识点总结
- 解决-使用html2canvas截取页面时,页面的div背景图无法截取并跨域
热门文章
- JavaBean规范、EL、JSTL、
- 围绕HugeTLB的极致优化
- VUE3.x(v-for)循环遍历指令
- Spring Boot 学习之Controller
- 动易 dw css不对,动易2019后台管理编辑器后台无法插入任何东西..._网络编辑_帮考网...
- visual c语言编译运行结果,Visual Studio 2015编译运行C语言文件问题小结
- linux端口转发_详解Linux网桥功能--概念、工作机制、相关命令及实例说明
- python两个csv表数据合并_怎么用python把一个*。csv 文件里面的数据整合成一个表格...
- kali linux引导文件修复,Kali+Windows引导修复
- java编写一个框架_手把手教你写一个基于 RxJava 的扩展框架