产品经理所理解的接口

产品经理所理解的接口,第1张

本文目标用户:

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

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

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

一.API接口的定义

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

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

二.API接口的业务场景

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

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

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

三.看懂API接口

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

1.接口描述

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

2.接口地址

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

3.请求方法

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

4.请求参数

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

5.返回结果

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

6.异常情况

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

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

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

用户使用 Web 客户端访问 Web 系统,系统在收到请求后执行 *** 作

(收集数据模型漏亮,选择数据经行组装),将结果返回给客户。

其中包括的元素和关系如下图所示:

约定

每个规范也会对应若干规定若干规则约定来指导前后端工程师的具体实施。

页面入口规范(范例)

同步数据规范(范例)

异步接口液搜宴规范(范例)

通过 模拟数据 的形成,将前端本地开发与后端独立出来,

这样前端工程师就可以独立的进行本地的开发工作。

使用页面入口规范制定项目结构(配置信息,目录结构和模板结构),

此过程可以使用自动化工具自动完成。

根据同步数据规范可生成模拟数据的配置文件。(此部分通用可以使用自动化工具来完成)

根据异步接口规范生成模拟异步数据。

前端开发环境包含两个部分, 本地模拟服务器 本地代理

Local Server

根据请求规则进行匹配,然闹银后生成(整合模板和模拟数据)所请求的页面

Local Proxy

拦截异步请求后,根据请求的匹配规则返回所请求的数据(例如 JSON 或 XML)。

前后端联调需要去除本地环境,在实际开发中只需要对配置文件进行调整既可

(控制哪些请求需要被本地服务器或代理拦截,哪些需要使用远程服务器)。


欢迎分享,转载请注明来源:内存溢出

原文地址: http://outofmemory.cn/yw/8267396.html

(0)
打赏 微信扫一扫 微信扫一扫 支付宝扫一扫 支付宝扫一扫
上一篇 2023-04-14
下一篇 2023-04-14

发表评论

登录后才能评论

评论列表(0条)

保存