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

标签 spring-restdocs

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

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

问候, 苏里亚

最佳答案

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

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

关于spring-restdocs - 如何使用 spring-restdocs 记录 http 错误代码,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/36559367/

相关文章:

android - 如何在Android中使用Spring RestTemplate在 Elasticsearch 中通过Json搜索

spring - 在 AsciiDoc(Spring Rest 文档)中使用选项卡

java.lang.AssertionError : Status expected:<200> but was:<404> in Junit test 错误

java - Spring REST 文档测试中未使用自定义 Jackson 模块

java - spring auto rest 文档中枚举列表的自动显示不是解释性的

java - 记录不带正文但包含路径和查询参数的 PUT REST 调用

spring-restdocs 字段说明来自注解

java - Spring REST 模拟上下文路径

rest - 与 Swagger 相比,使用 Spring REST Docs 有什么好处

spring - 无法使用 Cucumber 生成 Spring 休息文档