如何使用 spring-restdocs 记录 http 错误代码

Question

有没有办法使用 spring-restdocs 记录 http 错误代码？我在http://docs.spring.io/spring-restdocs/docs/current/reference/html5/ 上没有找到任何相同的东西

任何有关示例的帮助将不胜感激。

问候， 苏里亚

Answer 1

Spring REST Docs 不提供任何内容来帮助您记录 HTTP 错误代码。从理论上讲，实际上并没有必要记录错误代码，当然也不需要记录 API 中的每个资源。

HTTP 规范为其错误代码提供了定义，您的 API 应遵守这些定义。这允许 API 的用户使用他们现有的 HTTP 知识，而不必学习特定于 API 的新知识。如果您不确定您的用户是否已经掌握了这些知识，您可以在文档的概述部分中包含一些有关 HTTP 错误代码的信息。这是 Spring REST Docs 的示例项目之一中采用的方法。 Asciidoctor source 和生成的 HTML documentation 都可以在线获得。