Example usage for org.springframework.restdocs.http HttpDocumentation httpResponse

List of usage examples for org.springframework.restdocs.http HttpDocumentation httpResponse

  1. HOME
  2. Java
  3. org.springframework
  4. org.springframework.restdocs.http.*
  5. HttpDocumentation
  6. httpResponse

Introduction

In this page you can find the example usage for org.springframework.restdocs.http HttpDocumentation httpResponse.

Prototype

public static HttpResponseSnippet httpResponse()

Source Link

Document

Returns a Snippet that will document the HTTP response for the API operation.

Usage

From source file:capital.scalable.restdocs.misc.SectionSnippetTest.java

@Test
public void defaultSnippets() throws Exception {
    HandlerMethod handlerMethod = new HandlerMethod(new TestResource(), "getItemById");

    setField(snippet, "expectedType", "section");
    this.snippet.withContents(equalTo("[[resources-defaultSnippets]]\n" + "=== Get Item By Id\n\n"
            + "include::{snippets}/defaultSnippets/method-path.adoc[]\n\n"
            + "include::{snippets}/defaultSnippets/description.adoc[]\n\n" + "==== Authorization\n\n"
            + "include::{snippets}/defaultSnippets/authorization.adoc[]\n\n" + "==== Path parameters\n\n"
            + "include::{snippets}/defaultSnippets/path-parameters.adoc[]\n\n" + "==== Query parameters\n\n"
            + "include::{snippets}/defaultSnippets/request-parameters.adoc[]\n\n" + "==== Request fields\n\n"
            + "include::{snippets}/defaultSnippets/request-fields.adoc[]\n\n" + "==== Response fields\n\n"
            + "include::{snippets}/defaultSnippets/response-fields.adoc[]\n\n" + "==== Example request\n\n"
            + "include::{snippets}/defaultSnippets/curl-request.adoc[]\n\n" + "==== Example response\n\n"
            + "include::{snippets}/defaultSnippets/http-response.adoc[]\n"));

    new SectionBuilder().build().document(operationBuilder
            .attribute(HandlerMethod.class.getName(), handlerMethod)
            .attribute(ATTRIBUTE_NAME_DEFAULT_SNIPPETS,
                    Arrays.asList(authorization("Public"), pathParameters(), requestParameters(),
                            requestFields(), responseFields(), curlRequest(), HttpDocumentation.httpResponse()))
            .request("http://localhost/items/1").build());
}

From source file:capital.scalable.restdocs.misc.SectionSnippetTest.java

@Test
public void customSnippets() throws Exception {
    HandlerMethod handlerMethod = new HandlerMethod(new TestResource(), "getItemById");

    setField(snippet, "expectedType", "section");
    this.snippet.withContents(equalTo("[[resources-customSnippets]]\n" + "=== Get Item By Id\n\n"
            + "include::{snippets}/customSnippets/method-path.adoc[]\n\n"
            + "include::{snippets}/customSnippets/description.adoc[]\n\n" + "==== Example response\n\n"
            + "include::{snippets}/customSnippets/http-response.adoc[]\n\n" + "==== Response fields\n\n"
            + "include::{snippets}/customSnippets/response-fields.adoc[]\n\n" + "==== Example request\n\n"
            + "include::{snippets}/customSnippets/http-request.adoc[]\n"));

    new SectionBuilder().snippetNames(HTTP_RESPONSE, RESPONSE_FIELDS, HTTP_REQUEST).build()
            .document(operationBuilder.attribute(HandlerMethod.class.getName(), handlerMethod).attribute(
                    ATTRIBUTE_NAME_DEFAULT_SNIPPETS,
                    Arrays.asList(pathParameters(), requestParameters(), requestFields(), responseFields(),
                            curlRequest(), HttpDocumentation.httpRequest(), HttpDocumentation.httpResponse()))
                    .request("http://localhost/items/1").build());
}

From source file:capital.scalable.restdocs.misc.SectionSnippetTest.java

@Test
public void skipEmpty() throws Exception {
    HandlerMethod handlerMethod = new HandlerMethod(new TestResource(), "getItemById");

    setField(snippet, "expectedType", "section");
    this.snippet.withContents(equalTo("[[resources-skipEmpty]]\n" + "=== Get Item By Id\n\n"
            + "include::{snippets}/skipEmpty/method-path.adoc[]\n\n"
            + "include::{snippets}/skipEmpty/description.adoc[]\n\n" + "==== Authorization\n\n"
            + "include::{snippets}/skipEmpty/authorization.adoc[]\n\n" + "==== Example request\n\n"
            + "include::{snippets}/skipEmpty/curl-request.adoc[]\n\n" + "==== Example response\n\n"
            + "include::{snippets}/skipEmpty/http-response.adoc[]\n"));

    new SectionBuilder().skipEmpty(true).build().document(operationBuilder
            .attribute(HandlerMethod.class.getName(), handlerMethod)
            .attribute(ATTRIBUTE_NAME_DEFAULT_SNIPPETS,
                    Arrays.asList(authorization("Public"), pathParameters(), requestParameters(),
                            requestFields(), responseFields(), curlRequest(), HttpDocumentation.httpResponse()))
            .request("http://localhost/items/1").build());
}