api - REST API 请求失败 http 响应代码

Question

我正在实现一个 REST API，例如我有一个 set_ftp_credentials 请求

POST api.domain.com/object/set_ftp_credentials

此请求通过尝试连接来检查 ftp 凭据是否良好。
我们在这里讨论了是否应该返回 HTTP 响应 200 并在内容中
返回请求失败以及原因。
或者我们应该返回一些其他的 HTTP 响应代码（40* 响应代码）。

什么被认为是正确的做法？

如果不是 200，那么您认为正确的响应代码是什么？

Answer 1

我相信 200 是一个 OK 响应，只有在成功满足请求时才应该发送。

Answer 2

一种方法是自己回答以下问题：

1. 您支持哪些 HTTP 方法？
2. 每个 HTTP 方法的预期行为是什么？
3. 对于每种支持的 HTTP 方法，如果出现问题，可能会导致哪些故障类别？

现在，使用 200 HTTP 响应代码返回您预期的响应负载。返回失败的客户端错误（400 类）或服务器端错误（500 类）。

您可能需要考虑以下事项：

• 返回特定于您的应用程序的错误代码并将它们映射到 HTTP 错误代码
• 为成功响应和错误响应定义了单独的数据协定（假设 JSON 格式或 XML 模式）