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

Question

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

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

问候，苏里亚

Answer 1

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

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