之前课上讲过好多次接口开发的流程以及什么是接口开发,但是仍有好多同学不理解,在这做一个总结,希望能帮助到“不明白什么是接口开发”以及“不知道如何进行接口开发”的同学。 一、什么是接口开发? 接口开发,可以理解成面向接口开发(接口实际上就是定义的一组规范,并且接口开发具有解耦和可扩展的优点),即多个应用程序通过接口进行数据交互,并且接口开发一般分为“服务提供者(接口的提供者)”与“服务消费者(接口调用者)”。 二、如何进行接口开发? 1.根据需求进行业务分析(例如:需求:用户注册 分析:我们在做用户注册功能时,用户一般都可以通过手机号发送的短信验证码实现注册,所以我们要使用户可以通过手机号,手机验证码注册用户,并且用户名不能重复,密码也要有一定的规则) 2.定义接口文档(这是最重要的一步,接口文档是“服务提供者(接口的提供者)”与“服务消费者(接口调用者)”沟通的桥梁,一般是“服务提供者(接口的提供者)”定义),那么我们就根据上面的需求定义我们的接口文档 首先接口文档包括3大部分: 1.请求路径+请求方式 url:http://www.alidayu.com/xxxx methodType:GET|POST|PUT|DELETE...(任选一种) 2.请求参数(规范:名称 类型 是否必选 示例值 描述),如下图:
3.响应参数(规范:名称 类型 是否必选 示例值 描述,并且一般响应参数必须要返回“Code(状态码)”,“Success(是否成功)”,“Msg(消息提示)”,如果有数据返回的话,就可以自己定义就好了),如下图:
3.服务提供者(接口的提供者)”与“服务消费者(接口调用者)”并行开发,并分别进行单元测试 4.服务提供者(接口的提供者)”与“服务消费者(接口调用者)”联调测试,测试是否可以进行数据交互,并且交互的数据的正确性,安全性,效率是否达标。 5.测试人员验证,自此接口开发完成。 以上就是我对于接口开发的理解,不足之处敬请在留言区指正,欢迎大家进行批评指正!
|