如何解决在 API Blueprint 中使用数据结构子集属性
我有以下数据结构,用于对与应用程序域相关的客户端进行建模,我想用 API 蓝图记录该应用程序域。
## Data Structures
### Client
+ id: (number,required)
+ name: (string,required)
+ email: (string)
...
当 API 用户请求 GET over 和端点(如 /users/{client_id}
)时,我可以返回数据结构 Client
作为响应。
现在,让我们假设当我创建一个新客户端或更新现有客户端时,有一些属性不允许通过 POST 或 PUT 请求。例如,我不想更新电子邮件属性。
我是否应该定义另一个数据结构来对这个约束进行建模,以便明确在这些特定场景中需要哪些属性,还是只使用原始客户端就可以了?
这可能是插入/更新操作中预期的客户端属性子集的示例:
### ClientUpsertForm
+ name: (string,required)
(other updateable attributes)
版权声明:本文内容由互联网用户自发贡献,该文观点与技术仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请发送邮件至 dio@foxmail.com 举报,一经查实,本站将立刻删除。