产品经理应该如何正确的阅读API文档?(二)
产品经理应该如何正确的阅读API文档?前面我们介绍了什么是API文档,接下来就来具体的看看API文档的结构,以及阅读API文档的好处。
API文档的结构
一般来说,一个API文档会包含多个API信息,一个API信息通常包括以下内容:
接口描述:这个接口是用来做什么的,相关规则是什么;
接口地址:以网址的形式显示,你通过发送请求给这个网址来对接口进行交互操作;
请求方法:常用的有post和get两种方式,一种是读接口(常用get),另一种是写接口(常用post);
请求参数:请求接口时,需要提供参数,参数属性包括名称,类型,是否必需,描述等;
返回参数:接口正常响应后,返回的内容;
错误代码:接口请求失败后返回的错误代码。
阅读API文档的好处
对技术理解更深刻,让产品更有想象力
想象一下这样一个场景,如果你是小程序的PM,但又不去阅读开发文档,可能会导致的结果就是,小程序有许多最新功能,但你却不知道如何应用到自己的产品中;或者,即使知道大概有这么一回事,也不知道具体可以做的操作细节有哪些,在自己的产品中应用场景在哪里,而往往产品细节和场景又是如此重要。
说白了,没有新技术就没有新的想象力。
那么阅读API文档的好处只有这一个吗?当然不是!下篇文章会继续介绍阅读API文档的好处,大家可以继续去看看。
以上就是“产品经理应该如何正确的阅读API文档?(二)”的内容了,如果你还想了解其他相关内容,可以来 产品壹佰 官方网站,或者扫码关注产品壹佰的官方公众号。
API文档的结构
一般来说,一个API文档会包含多个API信息,一个API信息通常包括以下内容:
接口描述:这个接口是用来做什么的,相关规则是什么;
接口地址:以网址的形式显示,你通过发送请求给这个网址来对接口进行交互操作;
请求方法:常用的有post和get两种方式,一种是读接口(常用get),另一种是写接口(常用post);
请求参数:请求接口时,需要提供参数,参数属性包括名称,类型,是否必需,描述等;
返回参数:接口正常响应后,返回的内容;
错误代码:接口请求失败后返回的错误代码。
阅读API文档的好处
对技术理解更深刻,让产品更有想象力
想象一下这样一个场景,如果你是小程序的PM,但又不去阅读开发文档,可能会导致的结果就是,小程序有许多最新功能,但你却不知道如何应用到自己的产品中;或者,即使知道大概有这么一回事,也不知道具体可以做的操作细节有哪些,在自己的产品中应用场景在哪里,而往往产品细节和场景又是如此重要。
说白了,没有新技术就没有新的想象力。
那么阅读API文档的好处只有这一个吗?当然不是!下篇文章会继续介绍阅读API文档的好处,大家可以继续去看看。
以上就是“产品经理应该如何正确的阅读API文档?(二)”的内容了,如果你还想了解其他相关内容,可以来 产品壹佰 官方网站,或者扫码关注产品壹佰的官方公众号。