WebAPI接口对接

135 阅读1分钟

WebAPI接口对接:

提示:此片文章是总结接口对接经验其中包括模型的建立以及统一的调用


学习内容:

  1. 数据对象模型的建立
  2. 如何规范定义模型
  3. 统一的请求方法
  4. 系统中model的命名

  • 数据对象的建立

接口的数据传输对象包括Request对象和Response对象
在这里插入图片描述
每一个接口都单独建立一个文件夹
在这里插入图片描述

  • 规范定义模型

定义一个统一的父类(这是Request的统一父类)
GetApi方法是用于获取接口请求路径用的 (这里要注意Request是继承ResPonse的)
在这里插入图片描述

这里是Response的父类,父类中又接口的公用属性,每个接口返回都又这些参数。

在这里插入图片描述
接下来我们来看一个接口的返回和请求类

请求数据传输对象
在这里插入图片描述
返回数据对象
在这里插入图片描述

  • 统一的请求方法

![在这里插入图片描述](https://img-blog.csdnimg.cn/eff350a6f86143ecaf856f2443f6d3e6.png
当然你有可以继承这个请求方法的接口去根据每一个接口的需求重写它
例如
在这里插入图片描述

其实这种写法用到的领域驱动设计

系统中model的命名规则

关于DO,DTO和VO在项目

DO:对应数据库表结构

VO:一般用于前端展示用

DTO:用于数据传递(接口入参和接口返回值都可以)