Grails 3 - Spring Rest Docs 使用 Rest assured 在使用 JSON 视图时给出 SnippetException

Question

我正在尝试将 Spring REST 文档与 Grails 3.1.4 应用程序放心地集成。我正在使用 JSON 视图。

完整代码在https://github.com/rohitpal99/rest-docs

当我使用

在 NoteController 中

List<Note> noteList = Note.findAll()
Map response = [totalCount: noteList.size(), type: "note"]
render response as grails.converters.JSON

文档生成效果很好。

但我想使用 JSON 像

这样的视图

respond Note.findAll()

我在 /views 目录中有 _notes.gson 和 index.gson 文件。我得到一个 SnippetException。通常的 /notes GET 请求响应是正确的。

rest.docs.ApiDocumentationSpec > test and document get request for /index FAILED
    org.springframework.restdocs.snippet.SnippetException at ApiDocumentationSpec.groovy:54

没有消息。无法追踪它发生的原因。请建议。

完整堆栈跟踪

    org.springframework.restdocs.snippet.SnippetException: The following parts of the payload were not documented:
{
  "instanceList" : [ {
    "title" : "Hello, World!",
    "body" : "Integration Test from Hello"
  }, {
    "title" : "Hello, Grails",
    "body" : "Integration Test from Grails"
  } ]
}
    at org.springframework.restdocs.payload.AbstractFieldsSnippet.validateFieldDocumentation(AbstractFieldsSnippet.java:134)
    at org.springframework.restdocs.payload.AbstractFieldsSnippet.createModel(AbstractFieldsSnippet.java:74)
    at org.springframework.restdocs.snippet.TemplatedSnippet.document(TemplatedSnippet.java:64)
    at org.springframework.restdocs.generate.RestDocumentationGenerator.handle(RestDocumentationGenerator.java:192)
    at org.springframework.restdocs.restassured.RestDocumentationFilter.filter(RestDocumentationFilter.java:63)
    at com.jayway.restassured.internal.filter.FilterContextImpl.next(FilterContextImpl.groovy:73)
    at org.springframework.restdocs.restassured.RestAssuredRestDocumentationConfigurer.filter(RestAssuredRestDocumentationConfigurer.java:65)
    at com.jayway.restassured.internal.filter.FilterContextImpl.next(FilterContextImpl.groovy:73)
    at com.jayway.restassured.internal.RequestSpecificationImpl.applyPathParamsAndSendRequest(RequestSpecificationImpl.groovy:1574)
    at com.jayway.restassured.internal.RequestSpecificationImpl.get(RequestSpecificationImpl.groovy:159)
    at rest.docs.ApiDocumentationSpec.$tt__$spock_feature_0_0(ApiDocumentationSpec.groovy:54)
    at rest.docs.ApiDocumentationSpec.test and document get request for /index_closure2(ApiDocumentationSpec.groovy)
    at groovy.lang.Closure.call(Closure.java:426)
    at groovy.lang.Closure.call(Closure.java:442)
    at grails.transaction.GrailsTransactionTemplate.doInTransaction(GrailsTransactionTemplate.groovy:70)
    at org.springframework.transaction.support.TransactionTemplate.execute(TransactionTemplate.java:133)
    at grails.transaction.GrailsTransactionTemplate.executeAndRollback(GrailsTransactionTemplate.groovy:67)
    at rest.docs.ApiDocumentationSpec.test and document get request for /index(ApiDocumentationSpec.groovy)

Answer 1

如果您尝试记录不存在的内容或未能记录存在的内容，REST Docs 将无法通过测试。您在测试中记录了两个字段：

responseFields(
    fieldWithPath('totalCount').description('Total count'),
    fieldWithPath('type').description("Type of result")
)))

REST Docs 未通过测试，因为响应的某些部分未记录在案。特别是一个 instanceList 数组，其中包含具有两个键的映射：title 和 body。你可以用这样的东西记录那些和其他两个字段：

responseFields(
    fieldWithPath('totalCount').description('Total count'),
    fieldWithPath('type').description("Type of result"),
    fieldWithPath('instanceList[].title').description('Foo'),
    fieldWithPath('instanceList[].body').description('Bar')
)))

Answer 2

如果您不关心可能丢失的字段，您可以使用 relaxedResponseFields 而不是 responseFields:

relaxedResponseFields(
    fieldWithPath('totalCount').description('Total count'),
    fieldWithPath('type').description("Type of result")
))

如果没有提到某些字段，这将不会通过测试。

Grails 3 - Spring Rest Docs 使用 Rest assured 在使用 JSON 视图时给出 SnippetException

Grails 3 - Spring Rest Docs using Rest assured giving SnippetException when using JSON views

rest

grails

spring

spring-restdocs

grails-3.1