写给产品的技术科普——API 接口

自从做了研发类产品,老有童鞋找我问什么是接口什么是前端后端,回答次数多了,想着所幸写一篇出来,希望对更多人有所帮助

接口的缘起

很久以前,页面没有现在这么花狸狐哨,以静态为主,最原始的开发模式,应该是不分什么前后端的,可能只有 “xx开发工程师”,Java 程序员一个人从底层存储到逻辑到前端交互全写了,所谓全栈、全能啊。

但是万物发展规律都是——事态越来越复杂,各自分工做专长的事情最为高效,因此前后端分离了。

『后端』 即 服务端,负责做数据的存储,业务功能逻辑的实现,常和数据库、服务器、环境打交道;

『前端』广义来讲,包括 Web 前端、iOS 及 Android 等客户端、RN 及 Flutter 等跨端开发,负责页面的实现,包括页面的框架结构、UI 样式,以及用户行为的交互逻辑反馈,所以更着重处理用户体验相关的事情。

那后端开发好这些功能,怎么给用户用呢?不能让用户输入代码吧,铛铛铛,这就是『接口』上场的时候啦!!

接口工作的原理

API,Application Programming Interface,直译就是应用程序接口嘛,还是听不懂对不对?其实可以这么理解,用户和界面交互的过程 就是 前端通过某个东西(比如ajax)调用后端写好的接口(比如 restful API) 进行 数据交互 的过程。所以说,接口即服务、接口即能力

什么是接口文档

一般产品需求评审之后,各端同学开始真正开发之前,会先规定好怎么传输数据,传什么样的数据,这个规定就是『接口文档』。
不规定这个东西会肿么样?相信我,前后端会打架的。前端埋怨后端:“我要是的xx,你这返回的是啥?” 后端也会气死:“不是说好的xxx吗?怎么xxx?!” 真实工作中,即便是有这份接口规定,测试阶段也会有一堆 bug 是和接口定义沟通有关。

言归正传,接口文档一般包含:接口基本信息、请求头、请求体(入参)、返回值(出参)、示例等几部分。

(1)基本信息:包括接口名称、URL、请求方式、描述

  • URL可理解为接口的地址 ID,规定了前端去哪儿请求数据。如:api/queryOrder

  • 请求方式类似指 提交数据(POST)、读数据(GET)、更新数据(PUT)、删数据(DELETE)什么的,不用了解太细,常用的一般就是POST和GET,数据一般不会轻易删除,所以 DELETE 用得较少。

(2)请求头 Header

  • 负责一些比较全局的规定,比如用 Accept 指定客户端能够接收的内容类型,对于产品来说其实不用太了解。

(3)入参/请求内容/请求体 Body

  • 请求体就是前端请求这个接口时需要给的字段规则;
  • 包括:入参字段名 Value、含义、字段类型、是否必填、格式、长度规则等等。

(4)出参/返回值/响应体 Response

  • 返回值就是服务端同学根据请求内容传回具体的信息,一般包括请求结果、状态码以及返回值等。
  • 请求结果是指是否成功,success 为 true 还是 false;
  • 状态码 code 和状态消息 msg 是一一对应的,一般会统一管理;
  • 返回值一般是封在一个 data 的数组或者对象里,包括字段名、描述、字段类型等。
  • 入参和返回值是最和产品需求相关的部分,如果产品同学懂数据结构,和研发交流起来就会更 easy~

举个栗子

比如你买火车票时,输入乘车时间、出发站、到达站、车次等条件后,就会得到一个火车票列表。此时就是用到了查询火车票列表接口。那么这份接口文档一般如下:

  • 基本信息:
    URL:xxxxx/trains
    类型:GET
    接口描述:火车票列表查询接口,根据始发站等条件获取火车票列表数据

  • 入参:
    参数名 | 必填 | 类型 | 说明
    --|--|--|--
    from_stationID | Long | Y | 出发站ID
    to_station | Long | Y | 到达站ID
    train_date | Date | Y | 乘车日期,格式:yyyy-MM-dd
    train_code | String | N | 车次号
    purpose_code | String | Y | 车票类型,枚举,成人票ADULT,学生票STUDENT

(你会发现,其实是否必填就对应了你点击 搜索 按钮是否会弹窗提醒“请输入xx”)

  • 出参:
    参数名|类型|说明
    --|--|--
    map|object|出发到达信息
    result|array|车次查询结果

最后

这些接口,都是HTTP协议的REST风格才这样,不走这个协议 风格就不一样了。不过不太常见,不用管。原理都是一样的。

现在大型公司,业务复杂,这个部门需要调用那个部门的能力的时候,走的微服务,我感觉本质都是一样的。封装好后开放出来,使用者按规则按需就可以调用。

有什么问题欢迎留言,有错误欢迎指正,有别的问题也欢迎来问~

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

推荐阅读更多精彩内容