Polish
This commit is contained in:
committed by
Andy Wilkinson
parent
3c80176e66
commit
09c9cac857
@@ -171,7 +171,7 @@ static content] by Spring Boot. To do so, configure your project's build so that
|
||||
1. The documentation is generated before the jar is built
|
||||
2. The generated documentation is included in the jar
|
||||
|
||||
[source,xml,indent=0,role="primary",role="primary"]
|
||||
[source,xml,indent=0,role="primary"]
|
||||
.Maven
|
||||
----
|
||||
<plugin> <1>
|
||||
@@ -253,7 +253,7 @@ When using JUnit, the first step in generating documentation snippets is to decl
|
||||
snippets should be written. This output directory should match the snippets directory that
|
||||
you have configured in your `build.gradle` or `pom.xml` file.
|
||||
|
||||
For Maven (`pom.xml` that will typically be `target/generated-snippets` and for
|
||||
For Maven (`pom.xml`) that will typically be `target/generated-snippets` and for
|
||||
Gradle (`build.gradle`) it will typically be `build/generated-snippets`:
|
||||
|
||||
[source,java,indent=0,role="primary"]
|
||||
|
||||
@@ -80,7 +80,7 @@ public class Payload {
|
||||
this.mockMvc.perform(get("/books/1").accept(MediaType.APPLICATION_JSON))
|
||||
.andExpect(status().isOk())
|
||||
.andDo(document("book", responseFields(book))); // <1>
|
||||
// end::single-book[]
|
||||
// end::single-book[]
|
||||
|
||||
// tag::book-array[]
|
||||
this.mockMvc.perform(get("/books").accept(MediaType.APPLICATION_JSON))
|
||||
|
||||
@@ -68,9 +68,9 @@ public class Payload {
|
||||
fieldWithPath("email").description("The user's email address")
|
||||
.attributes(key("constraints")
|
||||
.value("Must be a valid email address"))))) // <3>
|
||||
// end::constraints[]
|
||||
.when().post("/users")
|
||||
.then().assertThat().statusCode(is(200));
|
||||
// end::constraints[]
|
||||
.when().post("/users")
|
||||
.then().assertThat().statusCode(is(200));
|
||||
}
|
||||
|
||||
public void descriptorReuse() throws Exception {
|
||||
@@ -90,10 +90,9 @@ public class Payload {
|
||||
.filter(document("books", responseFields(
|
||||
fieldWithPath("[]").description("An array of books")) // <1>
|
||||
.andWithPrefix("[].", book))) // <2>
|
||||
.when().get("/books/1")
|
||||
.then().assertThat().statusCode(is(200));
|
||||
.when().get("/books/1")
|
||||
.then().assertThat().statusCode(is(200));
|
||||
// end::book-array[]
|
||||
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
@@ -21,7 +21,7 @@ import org.springframework.restdocs.operation.OperationResponse;
|
||||
|
||||
/**
|
||||
* An implementation of {@link OperationPreprocessor} that returns the request and
|
||||
* response as-is. To be subclasses by preprocessor implementations that only modify the
|
||||
* response as-is. To be subclassed by preprocessor implementations that only modify the
|
||||
* request or the response.
|
||||
*
|
||||
* @author Andy Wilkinson
|
||||
|
||||
Reference in New Issue
Block a user