This commit adds support for documenting a request's path parameters.
For example:
mockMvc.perform(
get("/locations/{latitude}/{longitude}", 51.5072, 0.1275))
.andExpect(status().isOk())
.andDo(document("locations").withPathParameters(
parameterWithName("latitude")
.description("The location's latitude"),
parameterWithName("longitude")
.description("The location's longitude")
));
Closes gh-86
22 lines
517 B
Groovy
22 lines
517 B
Groovy
plugins {
|
|
id 'org.asciidoctor.convert' version '1.5.2'
|
|
}
|
|
|
|
dependencies {
|
|
compile 'org.springframework:spring-webmvc'
|
|
|
|
testCompile project(':spring-restdocs')
|
|
testCompile 'junit:junit'
|
|
testCompile 'org.springframework:spring-test'
|
|
}
|
|
|
|
tasks.findByPath("artifactoryPublish")?.enabled = false
|
|
|
|
asciidoctor {
|
|
sources {
|
|
include 'index.adoc'
|
|
}
|
|
attributes 'revnumber': project.version,
|
|
'branch-or-tag': project.version.endsWith('SNAPSHOT') ? 'master': "v${project.version}"
|
|
inputs.files(sourceSets.test.java)
|
|
} |