第三方API返回500错误,我的API应返回什么代码

时间:2014-08-22 20:20:40

标签: rest http-status-codes apigility

我在基于名为Apigility的ZF2(Zend Framework 2)的框架中编写了一个API。

我的服务可以查询第三方API。偶尔,我会收到一条500错误消息..要么是因为过期的令牌,要么是等等。

我的API应如何回复给我的客户?

我一开始以为我应该回500,但实际上这似乎是错的。我不想返回一个错误,表明我已经崩溃了......这是第三方有500个。

更新:以下是我从第三方看到的内容。

我认为我喜欢503 Service unavailable的想法,但错误信息会让用户误解,以及如何解决问题。

更新显示第三方的回复:

Error performing request to OAuth Provider. 
HTTP/1.1 500 Internal Server Error
Server: nginx/1.1.19
Date: Fri, 22 Aug 2014 20:24:40 GMT
Content-Type: text/html
Content-Length: 20
Connection: close
X-Powered-By: PHP/5.3.10-1ubuntu3.1
Set-Cookie: lang_select_language=en; Expires=Sun, 21-Aug-2016 20:24:42 GMT; Path=/
X-WI-SRV: FR-EQX-WEB-03
Vary: Accept-Encoding
Content-Encoding: gzip

思想?

/**
 * Status titles for common problems
 *
 * @var array
 */
protected $problemStatusTitles = array(
    // CLIENT ERROR
    400 => 'Bad Request',
    401 => 'Unauthorized',
    402 => 'Payment Required',
    403 => 'Forbidden',
    404 => 'Not Found',
    405 => 'Method Not Allowed',
    406 => 'Not Acceptable',
    407 => 'Proxy Authentication Required',
    408 => 'Request Time-out',
    409 => 'Conflict',
    410 => 'Gone',
    411 => 'Length Required',
    412 => 'Precondition Failed',
    413 => 'Request Entity Too Large',
    414 => 'Request-URI Too Large',
    415 => 'Unsupported Media Type',
    416 => 'Requested range not satisfiable',
    417 => 'Expectation Failed',
    418 => 'I\'m a teapot',
    422 => 'Unprocessable Entity',
    423 => 'Locked',
    424 => 'Failed Dependency',
    425 => 'Unordered Collection',
    426 => 'Upgrade Required',
    428 => 'Precondition Required',
    429 => 'Too Many Requests',
    431 => 'Request Header Fields Too Large',
    // SERVER ERROR
    500 => 'Internal Server Error',
    501 => 'Not Implemented',
    502 => 'Bad Gateway',
    503 => 'Service Unavailable',
    504 => 'Gateway Time-out',
    505 => 'HTTP Version not supported',
    506 => 'Variant Also Negotiates',
    507 => 'Insufficient Storage',
    508 => 'Loop Detected',
    511 => 'Network Authentication Required',
);

3 个答案:

答案 0 :(得分:7)

嗯,我认为这取决于您,您将使用哪个错误代码。但是,如果您的API的实际功能取决于第三方API,我会考虑使用HTTP代码 503 Service Unavailable ,因为您的服务将无法使用,直到第三方API无效,无论第三方API返回什么HTTP代码。我还会在响应有效负载中包含一些细节(错误消息)。

或者您可以返回HTTP代码 200 OK ,并将自定义错误代码和消息作为响应有效内容发送,当然,因为对您的API的HTTP请求实际上是成功的。但我更愿意使用HTTP代码来指示API端点的状态。

只有当您的API充当代理而没有任何其他功能时,我才会将第三方API的HTTP代码镜像到用户。

答案 1 :(得分:2)

我认为这里的第一步是确定范围。 4xx表示用户有机会解决该请求,在此情况并非如此。 2xx听起来也不正确,因为请求不成功。这就给我们留下了很多5xx范围内的信息。

在5xx范围内,两个选项对我来说很合适。一个简单的500会很好:“有未指定的服务器错误”。 503听起来也不错,这表示“我们现在无法完成此操作,但以后可以执行(可以在标头中指定重试范围)。

答案 2 :(得分:0)

当客户端调用您的API时,它是直接还是间接指定它希望您的API与第三方服务进行通信?

  • 不 - 那么对于客户来说它将是500,因为它仍然是内部的 从客户的角度来看服务器错误。除非您的API可以解释来自的错误消息 第三方服务并获得更具体的错误代码。

  • 是的 - 那么 503似乎是最合适的。错误消息可能 指定哪些服务不可用。