Java接口开发流程总结

瘢痂柯里化
• 阅读 144

之前课上讲过好多次接口开发的流程以及什么是接口开发,但是仍有好多同学不理解,在这做一个总结,希望能帮助到“不明白什么是接口开发”以及“不知道如何进行接口开发”的同学。

一、什么是接口开发?

接口开发,可以理解成面向接口开发(接口实际上就是定义的一组规范,并且接口开发具有解耦和可扩展的优点),即多个应用程序通过接口进行数据交互,并且接口开发一般分为“服务提供者(接口的提供者)”与“服务消费者(接口调用者)”。

二、如何进行接口开发?

1.根据需求进行业务分析(例如:需求:用户注册   分析:我们在做用户注册功能时,用户一般都可以通过手机号发送的短信验证码实现注册,所以我们要使用户可以通过手机号,手机验证码注册用户,并且用户名不能重复,密码也要有一定的规则)

2.定义接口文档(这是最重要的一步,接口文档是“服务提供者(接口的提供者)”与“服务消费者(接口调用者)”沟通的桥梁,一般是“服务提供者(接口的提供者)”定义),那么我们就根据上面的需求定义我们的接口文档

                首先接口文档包括3大部分:

                        1.请求路径+请求方式

                                url:http://www.alidayu.com/xxxx

                                methodType:GET|POST|PUT|DELETE...(任选一种)

                        2.请求参数(规范:名称 类型 是否必选 示例值 描述),如下图:

                                 

 

 

                        3.响应参数(规范:名称 类型 是否必选 示例值 描述,并且一般响应参数必须要返回“Code(状态码)”,“Success(是否成功)”,“Msg(消息提示)”,如果有数据返回的话,就可以自己定义就好了),如下图:

                         

 

 

3.服务提供者(接口的提供者)”与“服务消费者(接口调用者)”并行开发,并分别进行单元测试

4.服务提供者(接口的提供者)”与“服务消费者(接口调用者)”联调测试,测试是否可以进行数据交互,并且交互的数据的正确性,安全性,效率是否达标。

5.测试人员验证,自此接口开发完成。

以上就是我对于接口开发的理解,不足之处敬请在留言区指正,欢迎大家进行批评指正

点赞
收藏
评论区
推荐文章
C_N_Candy C_N_Candy
4年前
Postman接口测试学习笔记(入门到精通)
Postman使用1.什么是接口:分为内外部接口,软件给外部提供的一种服务,用于数据传输2.软件为什么需要接口:接口能让内部数据被外部进行修改3.为什么要做接口测试:前后端分离,开发进度不一,测试左移,尽早测试。基于安全考虑,前端认证容易绕过,需要测试接口安全性。接口测试的本质:就是测试接口能否正常的交互数据,权限控制以及异常场景接口测试协议1.w
Wesley13 Wesley13
3年前
PHP 开发 APP 接口
APP版本升级以及APP演示①版本升级分析以及数据表设计② 版本升级接口开发以及APP演示!(https://oscimg.oschina.net/oscnet/e2bbac4a62f67997e4684c8ad4485029fd5.png)!(https://oscimg.oschina.net/oscnet/8
Easter79 Easter79
3年前
Springboot整合elasticsearch以及接口开发
Springboot整合elasticsearch以及接口开发搭建elasticsearch集群搭建过程略(我这里用的是elasticsearch5.5.2版本)写入测试数据新建索引book(非结构化索引)PUThttp://192.168.100.102:9200/book
Stella981 Stella981
3年前
Android Camera 相机开发详解
在Android5.0(SDK21)中,Google使用Camera2替代了Camera接口。Camera2在接口和架构上做了巨大的变动,但是基于众所周知的原因,我们还必须基于Android4.系统进行开发。本文介绍的是Camera接口开发及其使用方法,通过本文章,你将全面地学会Camera接口的开发流程。本图文与GitHubPages原
京东云开发者 京东云开发者
5个月前
Java的SPI机制详解
作者:京东物流杨苇苇1.SPI简介SPI(ServiceProvicerInterface)是Java语言提供的一种接口发现机制,用来实现接口和接口实现的解耦。简单来说,就是系统只需要定义接口规范以及可以发现接口实现的机制,而不需要实现接口。SPI机制在J
京东云开发者 京东云开发者
3个月前
Java的SPI机制详解
作者:京东物流杨苇苇1.SPI简介SPI(ServiceProvicerInterface)是Java语言提供的一种接口发现机制,用来实现接口和接口实现的解耦。简单来说,就是系统只需要定义接口规范以及可以发现接口实现的机制,而不需要实现接口。SPI机制在J
京东云开发者 京东云开发者
1个月前
Java的SPI机制详解
作者:京东物流杨苇苇1.SPI简介SPI(ServiceProvicerInterface)是Java语言提供的一种接口发现机制,用来实现接口和接口实现的解耦。简单来说,就是系统只需要定义接口规范以及可以发现接口实现的机制,而不需要实现接口。SPI机制在J
京东云开发者 京东云开发者
1个月前
Java的SPI机制详解
作者:京东物流杨苇苇1.SPI简介SPI(ServiceProvicerInterface)是Java语言提供的一种接口发现机制,用来实现接口和接口实现的解耦。简单来说,就是系统只需要定义接口规范以及可以发现接口实现的机制,而不需要实现接口。SPI机制在J
API 小达人 API 小达人
1年前
【遥遥领先】Eolink IDEA 插件:零代码入侵,自动生成接口
对于开发同学来说,无论是新增还是修改接口文档,都需要在开发工具和接口管理工具上同步最新的数据。而且接口文档变更内容会比较琐碎和频繁。那么是否有更轻便的同步接口数据方式呢?我们提供了一个高效方案:在开发工具上基于接口代码片段,一键生成API文档,支持在开发工具中调试,并可一键上传至EolinkApikit的代码仓库中。这样不仅可以减少界面的操作和系统间的切换,还可以在开发工具上完成琐碎和频繁的接口文档更新,是当前CODETOAPI的最佳实践。
火德星君 火德星君
1年前
最新汇总近百个程序员开发常用开放免费的api接口 (IT必备)
免费的API接口:为开发者提供无限可能随着互联网技术的飞速发展,越来越多的开发者开始借助API接口来实现各种功能的开发。API接口不仅能够简化开发流程,还可以让开发者们更专注于核心业务的创新。然而,一些高质量的API接口往往需要付费才能使用,这对于许多初创
API 小达人 API 小达人
1年前
使用 Eolink Apikit 进行 HTTP 接口测试
HTTP是互联网上应用最广泛的一种网络传输协议,所有的www文件都必须遵守这个标准。因此,在软件开发过程中,HTTP接口测试是必不可少的一环。传统的HTTP接口测试需要编写大量的测试代码,这对于开发人员来说是一项繁琐且耗时的工作。EolinkApikit是一款基于API文档的自动化HTTP接口测试工具,可以帮助开发人员快速、高效地完成HTTP接口测试。在本文中,我们将介绍EolinkApikit的HTTP接口测试流程,帮助开发人员快速入门。