Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Reproducer 181 #185

Closed
wants to merge 2 commits into from
Closed

Reproducer 181 #185

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9c9d166
reproduce issue 181
Aug 4, 2021
74fc93b
Solve #181 by using resource snippet
ooz Aug 10, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
48 changes: 48 additions & 0 deletions ...otlin/com/epages/restdocs/apispec/WebTestClientRestDocumentationWrapperIntegrationTest.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,15 @@ class WebTestClientRestDocumentationWrapperIntegrationTest(@Autowired val webTes
thenSnippetFileExists()
}

@Test
fun should_document_restdocs_and_resource_snippet_details_with_parameter_with_type() {
givenEndpointInvoked()

whenDocumentedWithResourceSnippetDetailsWithParameterWithType()

thenSnippetFileExists()
}

@Test
fun should_document_request() {
givenEndpointInvoked()
Expand Down Expand Up @@ -276,4 +285,43 @@ class WebTestClientRestDocumentationWrapperIntegrationTest(@Autowired val webTes
)
)
}

@Throws(Exception::class)
private fun whenDocumentedWithResourceSnippetDetailsWithParameterWithType() {
val operationRequestPreprocessor = OperationRequestPreprocessor { r -> r }
bodyContentSpec
.consumeWith(
WebTestClientRestDocumentationWrapper.document(
identifier = operationName,
requestPreprocessor = operationRequestPreprocessor,
snippets = arrayOf(
resource(
ResourceSnippetParametersBuilder()
.description("The Resource")
.privateResource(true)
.tag("some-tag")
.pathParameters(
ParameterDescriptorWithType("someId")
.type(SimpleType.BOOLEAN)
.description("someId"),
ParameterDescriptorWithType("otherId")
.type(SimpleType.NUMBER)
.description("otherId")
)
.requestFields(fieldDescriptors().fieldDescriptors)
.responseFields(
fieldWithPath("comment").description("the comment"),
fieldWithPath("flag").description("the flag"),
fieldWithPath("count").description("the count"),
fieldWithPath("id").description("id"),
subsectionWithPath("_links").ignored()
).links(
linkWithRel("self").description("some"),
linkWithRel("multiple").description("multiple")
).build()
)
)
)
)
}
}