如何使用 spring-restdocs 记录 http 错误代码
How to document http error codes using spring-restdocs
有没有办法使用 spring-restdocs 记录 http 错误代码?我在 http://docs.spring.io/spring-restdocs/docs/current/reference/html5/
上没有找到任何相同的内容
任何有关示例的帮助将不胜感激。
此致,
苏里亚
Spring REST Docs 不提供任何内容来帮助您记录 HTTP 错误代码。从理论上讲,并不是真的有必要记录错误代码,当然也不需要记录 API.
中的每个资源。
HTTP 规范为其错误代码提供了定义,您的 API 应遵守这些定义。这允许 API 的用户使用他们现有的 HTTP 知识,而不是必须学习一些特定于您的 API 的新知识。如果您不确定您的用户是否已经了解这些知识,您可以在文档的概述部分包含一些有关 HTTP 错误代码的信息。这是 Spring REST Docs 示例项目之一采用的方法。 Asciidoctor source and resulting HTML documentation 都可以在线获得。
有没有办法使用 spring-restdocs 记录 http 错误代码?我在 http://docs.spring.io/spring-restdocs/docs/current/reference/html5/
上没有找到任何相同的内容任何有关示例的帮助将不胜感激。
此致, 苏里亚
Spring REST Docs 不提供任何内容来帮助您记录 HTTP 错误代码。从理论上讲,并不是真的有必要记录错误代码,当然也不需要记录 API.
中的每个资源。HTTP 规范为其错误代码提供了定义,您的 API 应遵守这些定义。这允许 API 的用户使用他们现有的 HTTP 知识,而不是必须学习一些特定于您的 API 的新知识。如果您不确定您的用户是否已经了解这些知识,您可以在文档的概述部分包含一些有关 HTTP 错误代码的信息。这是 Spring REST Docs 示例项目之一采用的方法。 Asciidoctor source and resulting HTML documentation 都可以在线获得。