From d06cb46a4fa4497fd0c3c871b006837db5ef91aa Mon Sep 17 00:00:00 2001 From: John Thompson Date: Tue, 28 May 2019 19:36:56 -0400 Subject: [PATCH] adding documentation generation --- src/main/asciidoc/index.adoc | 36 +++++++++++++++---- .../web/controller/BeerControllerTest.java | 4 +-- .../restdocs/templates/request-fields.snippet | 18 +++++----- 3 files changed, 41 insertions(+), 17 deletions(-) diff --git a/src/main/asciidoc/index.adoc b/src/main/asciidoc/index.adoc index e509c69..bd9f9ff 100644 --- a/src/main/asciidoc/index.adoc +++ b/src/main/asciidoc/index.adoc @@ -9,21 +9,45 @@ Sample application demonstrating how to use Spring REST Docs with JUnit 5. `BeerOrderControllerTest` makes a call to a very simple service and produces three documentation snippets. +GET BEER + One showing how to make a request using cURL: -include::{snippets}/orders/curl-request.adoc[] +include::{snippets}/v1/beer-get/curl-request.adoc[] One showing the HTTP request: -include::{snippets}/orders/http-request.adoc[] +include::{snippets}/v1/beer-get/http-request.adoc[] And one showing the HTTP response: -include::{snippets}/orders/http-response.adoc[] +include::{snippets}/v1/beer-get/http-response.adoc[] Response Body: -include::{snippets}/orders/response-body.adoc[] - +include::{snippets}/v1/beer-get/response-body.adoc[] Response Fields: -include::{snippets}/orders/response-fields.adoc[] \ No newline at end of file +include::{snippets}/v1/beer-get/response-fields.adoc[] + +NEW BEER + +One showing how to make a request using cURL: + +include::{snippets}/v1/beer-new/curl-request.adoc[] + +One showing the HTTP request: + +include::{snippets}/v1/beer-new/http-request.adoc[] + +And one showing the HTTP response: + +include::{snippets}/v1/beer-new/http-response.adoc[] + +Response Body: +include::{snippets}/v1/beer-new/response-body.adoc[] + +Request Fields +include::{snippets}/v1/beer-new/request-fields.adoc[] + +Response Fields: +include::{snippets} \ No newline at end of file diff --git a/src/test/java/guru/springframework/sfgrestdocsexample/web/controller/BeerControllerTest.java b/src/test/java/guru/springframework/sfgrestdocsexample/web/controller/BeerControllerTest.java index ed4bd23..33af163 100644 --- a/src/test/java/guru/springframework/sfgrestdocsexample/web/controller/BeerControllerTest.java +++ b/src/test/java/guru/springframework/sfgrestdocsexample/web/controller/BeerControllerTest.java @@ -57,7 +57,7 @@ class BeerControllerTest { .param("iscold", "yes") .accept(MediaType.APPLICATION_JSON)) .andExpect(status().isOk()) - .andDo(document("v1/beer", + .andDo(document("v1/beer-get", pathParameters ( parameterWithName("beerId").description("UUID of desired beer to get.") ), @@ -88,7 +88,7 @@ class BeerControllerTest { .contentType(MediaType.APPLICATION_JSON) .content(beerDtoJson)) .andExpect(status().isCreated()) - .andDo(document("v1/beer", + .andDo(document("v1/beer-new", requestFields( fields.withPath("id").ignored(), fields.withPath("version").ignored(), diff --git a/src/test/resources/org/springframework/restdocs/templates/request-fields.snippet b/src/test/resources/org/springframework/restdocs/templates/request-fields.snippet index 5f83e8e..cd1e825 100644 --- a/src/test/resources/org/springframework/restdocs/templates/request-fields.snippet +++ b/src/test/resources/org/springframework/restdocs/templates/request-fields.snippet @@ -1,11 +1,11 @@ - |=== - |Path|Type|Description|Constraints +|=== +|Path|Type|Description|Constraints - {{#fields}} - |{{path}} - |{{type}} - |{{description}} - |{{constraints}} +{{#fields}} +|{{path}} +|{{type}} +|{{description}} +|{{constraints}} - {{/fields}} - |=== \ No newline at end of file +{{/fields}} +|=== \ No newline at end of file