gpt4 book ai didi

rest - 是一个空主体的 POST 请求和纯 ID 值的响应,采用文本格式 RESTful

转载 作者:行者123 更新时间:2023-12-05 06:24:12 25 4
gpt4 key购买 nike

在我们使用基于 jax-rs 框架的 REST API 项目中,有一个客户端点:

客户/

此端点有一个 POST 方法和一个空输入正文,状态为 SUCCESS (201) 的响应只是一个自动生成的纯文本格式的ID值,既不是JSON也不是XML

问题一:在RESTful API中发起空输入体的POST请求是否正常?

问题2:只返回一个纯文本格式的值的实现是否仍然是一个有效的RESTful API?这种实现是一种好的做法吗?这样的实现有什么问题?如何改进?我个人对这样的实现感到很奇怪,但我真的无法说出它的问题

如果我实现 POST 方法,我可能会返回 JSON 或 xml 格式的响应而不是纯文本值,例如:

{id: 1234567}

最佳答案

让端点接受一个空的 POST 请求是可以的。如果这在您的上下文中具有合理的含义,那是完全有效的。听起来这会创建一个新的编号资源,它不需要任何参数即可创建,因此用例非常好。您可能会或可能不会使用更好的整体设计来代替您在没有参数的情况下创建新资源的设计,但没有人知道更多细节。

至于返回明文内容,通常如果它对您的用例有意义,那也是完全有效的。在您的 API 中保持一致是个好主意,但没有内在的技术需要。例如,如果您的某些端点返回二进制数据(例如 PDF 文件),那么将其包装在 JSON 或 XML 或任何仅出于一致性目的的任何东西中绝对没有意义。因此,您的 API 中的混合响应类型通常没有问题。

话虽如此,如果您的某些端点返回 JSON 而另一些端点返回 XML 而另一些端点返回纯文本,这可能会让 API 的使用者感到困惑和恼火,因为他们需要预期各种不同的响应格式,这更比只需要一种响应格式要复杂。

关于rest - 是一个空主体的 POST 请求和纯 ID 值的响应,采用文本格式 RESTful,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/57815630/

25 4 0
Copyright 2021 - 2024 cfsdn All Rights Reserved 蜀ICP备2022000587号
广告合作:1813099741@qq.com 6ren.com