关于api文档:Apizza绑定数据模型

34次阅读

共计 298 个字符,预计需要花费 1 分钟才能阅读完成。

数据模型

1. 什么是数据模型?

咱们能够在开发前,先将响应对象,申请参数定义好,便于在编辑文档中进行绑定,一处定义,全局应用。极大进步了程序猿们的开发效率。

数据模型

  • 申请参数模型:次要用于申请参数
  • 返回对象模型:次要用户返回的数据中

2. 如何应用申请参数定义?

1. 定义申请参数模型

2. 绑定申请参数列表

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

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

1. 定义响应对象

2. 在浮动正文中,绑定响应对象参数

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

就能够进行绑定对象了。响应数据对象不论如何扭转,这里都能够进行同步更新。

正文完
 0