数据模型

1. 什么是数据模型?

我们可以在开发前,先将响应对象,请求参数定义好,便于在编辑文档中进行绑定,一处定义,全局使用。极大提高了程序猿们的开发效率。

数据模型

  • 请求参数模型:主要用于请求参数

  • 返回对象模型:主要用户返回的数据中

2. 如何使用请求参数定义?

1. 定义请求参数模型

2. 绑定请求参数列表

绑定完参数后,API文档的参数随时根据请求参数模型进行同步。实现我们一处编写,多处同步的设计理念。

3. 如何使用响应对象定义?

1. 定义响应对象

2. 在浮动注释中,绑定响应对象参数

在「开发模式」下,切换到文档,在返回示例下面点击「浮动注释」

就可以进行绑定对象了。响应数据对象不论如何改变,这里都可以进行同步更新。