内部错误（500）应该作为Swagger API文档的一部分吗？

Question

据我检查了许多Amazon / Google的swagger文件以及更多内容，该错误代码（或通常为5xx系列的错误代码）未显示为swagger文件的一部分。是他们的原因吗？
我之所以问是因为，当我们的一个微服务API无法与其他服务通信时，它返回500，因此我们想知道该错误代码是否应该包含在我们的swagger文件中。

Answer 1

通常，客户/消费者在收到5xx错误时不能做太多事情，因为这些纯粹是服务器端错误。因此，不必不成为您的API规范的一部分。

如果您认为，基于API引发的错误，客户端/消费者应采取某些措施（例如重试或尝试其他站点等），然后单击“是”。

Answer 2

我认为API文档仅应包含预期的错误，例如4xx错误。但是5xx是意外错误，不应记录在案。