如何使用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＆＃39;之一采用的方法。样本项目。 Asciidoctor source和生成的HTML documentation都可以在线获取。