如何做一个api接口?
413
2022-10-25
接口概念及接口的作用
通过接口调用数据,大概分为两类:
1)API接口调用:
通过接口调用第三方功能插件
2)http接口调用:
根据实际需求由开发写具体的接口代码解决具体场合的信息传输问题
例如:公司先上线了OA系统,后上线订单系统,订单系统需要同步OA系统的人员组织结构信息。那么就可以为OA系统创建一个接口,订单系统通过http接口向OA系统发起数据请求,获取人员结构信息
2.接口创建的主体:
基本原则:向谁请求数据则由谁作为数据源方负责定义数据接口
3.接口的定义:
接口定义范围:设定数据请求的口令、可以输出的数据范围、推送前的数据过滤和筛选、数据传输前的转化运算规则等
4.传输数据的转义
比如:调用接口的一方需要的是订单+商品维度的数据,但是数据源是订单维度的,则数据传输前需要转义为订单+商品维度的数据给到调用方
5.接口数据的获取方式:get和post
1)get获取:
代表请求获取即数据需求方传递请求参数(如:账号+密码),数据源按照协议响应,给出满足条件的数据到请求方(即返回参数)。适用于数据时效要求高的情况
2)post获取:
代表主动推送即数据生产方有数据更新,则触发推送,将所需字段传递给需求方。适用于数据时效不高或数据量大实时传输服务器压力大。
6.接口数据的流转
方式一:触发式
一旦一个参数值满足条件,则触发同步
方式二:定时任务
在不知道数据源什么时候更新,需求方设置一个定时任务的脚本,隔一段时间查询一次。请求的频率需要与更新的频率相协调。
7.接口的相关拓展
open api:
是指对外开发的接口,如百度地图API
SDK(“软体开发工具包”):
封装后的API集合功能更完善如:微信支付SDK
http接口:
是基于接口的传输方式(http协议)来命名的当然也有基于其他协议传输的接口
如:和Windows系统沟通,需要调用Windows的API
8.产品经理关于数据接口的工作方法论
产品经理向研发测试等同学输出数据接口的需求方案时,需要明确:
1)接口定义的规则是什么?
2)传参和返回参数是什么?
3)重复传参时是跳过or再获取?(一般是再获取)
4)必传参数是什么?
5)是否回传接收结果给数据生产方?
API数据接口服务
api接口是应用程序中的一种衔接,在很多软件中都有使用,api接口对于程序软件工作来说,非常重要。api接口服务是什么?api接口服务质量分析包括哪些方面?很多人对此都不清楚,下面小编就来给大家详细回答下吧。
一、api接口服务是什么?
应用程序API接口,就是软件系统不同组成部分衔接的约定。由于近年来软件的规模日益庞大,常常需要把复杂的系统划分成小的组成部分,编程接口的设计十分重要。程序设计的实践中,编程接口的设计首先要使软件系统的职责得到合理划分。
api接口服务质量分析
二、api接口有什么作用?
良好的接口设计可以降低系统各部分的相互依赖,提高组成单元的内聚性,降低组成单元间的耦合程度,从而提高系统的维护性和扩展性。应用程序接口是一组数量上千、极其复杂的函数和副程序,可让程序员做很多任务作,譬如“读取文件”、“显示菜单”、“在视窗中显示网页”等等。,数据平台提供各种针对不同类型的企业或创业者需要的数据,针对性比较强,可以逐一进入去根据自身需求,选择对应的数据api接口。
三、api接口服务质量分析包括哪些方面?
创建项目
根据 RESTful 规范,接口地址是POST /api/projects。虽然我们是脱离 UI 界面在开发接口,但页面的交互逻辑是必须清楚的(一般来说,会有交互设计稿)。对于创建项目来说,一般就是一个让用户填写项目信息的表单,里面有项目的名称和描述,用户填写完后,点击“提交”按钮提交表单数据,后端接收到数据后,在数据库中插入一条记录。这个就是创建项目的过程。
查询项目
项目创建完后,肯定要在页面上显示出来,有可能是单独的项目详情页面,也有可能是项目列表页面,都需要用到项目数据。所以需要有查询项目的接口,最常见的就是按项目 id 查单个项目,还有就是显示用户的项目列表。
api接口服务质量分析
修改项目
首先还是分析业务需求,修改这种操作,和具体的业务逻辑关系非常大,比如可以限制只有项目创建者可以修改项目,也可以让所有项目成员都可以修改项目。我们的需求最开始也已经描述过了“只有项目的管理员和创建者可以修改项目”。
根据project表,项目的名称和描述可以被修改
删除项目
根据前面的分析,删除项目的接口地址是DELETE /api/projects/:id,并且我们不是物理删除记录,而是去给deletedAt字段赋值。这个字段有值表示项目已经被删除。
上述就是小编为大家整理的API数据接口是什么?API数据接口服务
版权声明:本文内容由网络用户投稿,版权归原作者所有,本站不拥有其著作权,亦不承担相应法律责任。如果您发现本站中有涉嫌抄袭或描述失实的内容,请联系我们jiasou666@gmail.com 处理,核实后本网站将在24小时内删除侵权内容。
发表评论
暂时没有评论,来抢沙发吧~