产品经理所理解的接口

本文目标用户:

1.在产品设计中遇到有关于接口对接的经历,但是之前没有接触过类似对接。

2.想了解产品眼中的接口到底是什么东西?

3.对于已经明确了解并有相关对接的产品大佬们,欢迎你们指点。

一.API接口的定义

先来一段官方的解释:是一些预先定义的函数,或指软件系统不同组成部分衔接的约定。目的是提供应用程序与开发人员基于某软件或硬件得以访问一组例程的能力,而又无需访问原码,或理解内部工作机制的细节。

以产品的角度来讲,接口就是系统之间信息沟通的桥梁,通过接口我们能与不同的系统进行数据交换,以一个函数为例:比我y=x+1,当X系统传入一个参数,Y系统就会给我们按照函数逻辑给我们返回相应的值,我们不需要管Y系统内部具体的细节。

二.API接口的业务场景

在我个人的工作经历中,我把接口的业务场景分为2大类:一类是在程序内的接口调用。比如在用户登录时,输入账号密码调用登录接口去校验,这一类我们不考虑。

另一类是系统之间的接口调用。这一类中又可以细分为2类:一类是同一个平台内的系统之间的接口调用;比如在电商中,订单中心要想知道某个订单现在有没有发货,需要传递订单号到仓储中心,然后返回订单的发货状态。还一类是不同平台系统的接口调用;比如我们需要在页面上展示地图,直接调用高德或者百度的接口展示。

接口为我们的节省了大量的开发成本,对于两个独立的系统可以通过接口关联起来。不需要我们花费大量精力去构建一个完整的系统,而且对于一些需要的数据是来自外部数据的话,更不可能去搭建同一个系统。

三.看懂API接口

我们以一个接口文档的一个例子,来看看到底包含了哪些元素(作为产品,我们不需要去深究具体的实现细节,只需要知道接口的目的和相应的字段)

1.接口描述

简单的描述该接口的作用。

2.接口地址

表示要去哪里去找到该接口,得到响应。

3.请求方法

表示以哪种方法去请求接口的地址,一般是post或者get。(想具体了解可以问度娘)

4.请求参数

表示我们向接口调用时,需要传递哪些参数,这会根据具体的业务场景来设计字段以及具体的字段规则

5.返回结果

表示调用接口后给我们的返回结果

6.异常情况

有些接口文档还会考虑到异常情况,不同的异常情况如何处理。

以上是我看接口文档最关键的部分,对于一些更细节的元素如请求方式、签名和加密等个人认为没有必要看那么深,专业的事给专业的人做。

后续我会已具体的项目来说明具体怎么对接,以及怎么设计。感兴趣的朋友可以订阅我。

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 206,968评论 6 482
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 88,601评论 2 382
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 153,220评论 0 344
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 55,416评论 1 279
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 64,425评论 5 374
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,144评论 1 285
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,432评论 3 401
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,088评论 0 261
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 43,586评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,028评论 2 325
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,137评论 1 334
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,783评论 4 324
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,343评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,333评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,559评论 1 262
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,595评论 2 355
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,901评论 2 345

推荐阅读更多精彩内容