问题标签 [spring-auto-restdocs]

是否可以使用注释（在字段级别）为字段提供描述？

我知道我可以使用description方法

但我更愿意将该描述与字段定义放在我的响应对象中。

我知道我可以生成约束描述（http://docs.spring.io/spring-restdocs/docs/current/reference/html5/#_using_constraint_descriptions_in_generated_snippets），但它只为验证注释生成描述。

我正在寻找来自 Swagger的类似https://github.com/swagger-api/swagger-core/wiki/Annotations#apimodelproperty的东西。

I'm using Spring Auto REST Docs is an extension to Spring REST Docs to generate API documentation and I'm doing the set up the MockMvc as in the documentation.

As well, the same time I want generate the WireMock Stub with "http://cloud.spring.io/spring-cloud-contract/1.0.x/#_generating_stubs_using_restdocs"

I'm following this examples: https://github.com/spring-cloud-samples/spring-cloud-contract-samples

My problem is when I create a set up custom the WireMock Stub aren't created and when I use the default MockMvc configuration works but I need the custom configuration too.

Is it possible to generate the WireMock stub with a custom's configuration?

我使用 spring auto rest docs 生成了一个文档。这使用结合了 java 文档和 spring rest 文档的 capital.scalable 库。我的问题是描述请求字段时的枚举列表。类型列生成一个值作为Array[Object]。此外，描述列不会生成带有枚举值的must be one of语句，就像只有 Enum 是字段而不是枚举列表时那样。

以上是我拥有的枚举。当字段仅用作枚举时，它使用 tostring 正确显示在描述中。但是如果枚举列表即

是字段，那么它没有像上面提到的那样正确描述。

请让我知道应该怎么做才能更有效地生成文档？

我们有一个服务，它只是在 GET 请求中返回 json 文档。由于我们没有响应“模型”的 POJO，看来我们将无法使用自动响应字段生成“goodness”。

我们的一个选择是创建 Pojos（相当大，大约 50 个属性）和一个使用 pojos 的相应控制器。这很尴尬，因为我们现在必须维护模型和相应的控制器，以便我们可以自动生成模型。

任何关于我们如何仍然利用响应字段的自动生成的想法将不胜感激。

这是我所指的控制器：

我真的很喜欢使用 Javadoc 注释自动生成 REST 文档的想法！

我们的 REST API 的大部分是由 Spring Data REST 自动生成的（通过将 @RepositoryRestResource 添加到存储库）。如果也可以为这些生成 REST Docs，那就太好了——那将是高度自动化。

但不幸的是，大多数“自动”片段是“空的”（例如 auto-response-fields.adoc 仅包含链接列表 []-Attributes）。我想原因可能是 REST 控制器可能是由 Spring Data REST 动态创建的。目前我看不到如何为他们重用 Javadoc 注释。

有没有办法为 Spring Data REST 提供的此类 REST API 自动生成 REST 文档？手动告诉 Spring Auto REST Docs 在请求和响应中使用哪些类而不是让它静态发现它甚至会很有帮助——这可能吗？

我们还将 HATEOAS“_links”添加到大多数响应资源（通过将 ResourceProcessors 作为 Bean 提供）。这些链接包含 Spring REST Docs 使用的“标题”——如果我们用 HypermediaDocumentation.linkWithRel(...) 列出所有这些链接。这有点多余，如果可以自动处理所有带有“title”的_links，那就太好了。（但这可以通过在一些额外的代码中列出所有这些来完成，所以它不像 Spring Data REST 那样糟糕。）

如有必要，我还可以为我正在谈论的内容创建一个示例项目。

我的 spring RestApi 应用程序使用 RestDoc 成功生成了片段，但我无法使用这些片段自动生成要在前端运行的页面。http://localhost/docs返回 404 并且在 static/docs/ 中没有生成 html

到目前为止，我的 pom.xml 看起来像这样

我的 Junit Api 测试看起来像这样

我正在使用 Spring Auto REST Docs，并且想知道 failOnUndocumentedParams 的使用以及如何使用它。如果我错过了 POJO 中的一个字段，我希望不生成该文档。我相信使用 failOnUndocumentedParams 是我的解决方案。但是，我不知道如何以及在哪里使用它。

这是我的 mockMvc 的外观。

我不知道您如何使用 JavaDocs 和 Spring Auto Rest Docs。我可以使用 STS、UI 选项在本地生成我的 java-docs。但是，我不确定如何使用 Spring Auto Rest Docs 生成 java-docs。我尝试在 POM 中编写一些插件。但是 auto-description.adoc 和许多其他文档仍然是空的。

基本上我不知道如何让 Spring Auto Rest Docs 使用 Java Docs 来查找路径参数。我可以在终端上使用 mvn javadoc:javadoc 命令来创建在 target/site/apidocs/ 文件夹中创建的 Javadocs。但是我的 auto-path-parameters.adoc 中仍然没有参数

这是控制器，我使用的是 GraphQL，所以它不同：

使用路径参数，我没有得到错误的地方。并且只有 .adoc 文件是使用 Spring Auto Rest Docs 生成的，没有 JSON 文件。

是否可以将 spring-auto-restdocs 与 Swagger/SpringFox、swagger2markup 一起使用？

我想： - 使用 Swagger/SpringFox 提供测试区域，但是我希望该 UI 中的示例类似于 - spring-restdoc 提供示例代码片段和 - 使用 spring-auto-restdocs从 POJO 获取代表 JSON 对象的文档，只需将 Javadoc 添加到字段而不是招摇注释

目前，当使用 Spring Auto REST Docs 生成响应字段时，所有对象都被展平到响应中。例如考虑这两个类：

为 生成的响应字段Foo将包含两行Bar：

该bar行是否可能具有 type Bar，它链接到 asciidoc 中列出该Bar类型的响应字段的不同部分？

查看代码和文档，目前这似乎是不可能的。所以如果不是，有没有计划添加这样的东西？