REST API 最佳实践,用于 POST API 请求和响应对象建模



对于我的 POST API,在我的 Spring 启动应用程序中,我的请求和响应对象几乎相同,除了我的响应对象有一个额外的"时间戳"字段。

我应该将它们分开吗?或者有一个带有所有字段的公共POJO

RESTful 风格对此是否有一些指导方针,或者我们可以自由选择我们的方法?

任何文档的链接,如果相关,将非常有帮助!

谢谢!!

编辑 1 : 这是我的请求对象:-

public class UserRequest {
private String firstName;
private String lastName;
private String address;
}

和我的响应对象:-

public class UserResponse {
private String firstName;
private String lastName;
private String address;
private LocalDate date;
}

我正在将其用于 Spring 启动 JPA 应用程序。

我应该将其合并到一个名为">用户">的单个类中并保留包括"日期"在内的所有字段吗? 还是应该将请求和响应对象分开?

谢谢!

RESTful 风格对此是否有一些指导方针,或者我们可以自由选择我们的方法?

REST对消息设计没有太多要说的,除了指出我们应该专注于使用标准化的媒体类型,并以易于标准化的方式传达我们正在使用哪些类型。

如果您查看HTTP消息的定义,您会发现请求和响应共享相同的基本定义 - 两者之间的唯一区别是起始行的组成,即请求行或状态行。

但您可能会注意到,即使架构基本相同(这意味着您可以在这两种情况下选择使用相同的基础数据结构(,但在大多数类型化语言中,请求和响应将被视为不同的类型(因为语义不同(。

相关内容

  • 没有找到相关文章

最新更新