Java Snippet类代码示例

import org.springframework.restdocs.snippet.Snippet; //导入依赖的package包/类
public static RestDocumentationResultHandler document(String identifier,
                                                      String description,
                                                      boolean privateResource,
                                                      OperationRequestPreprocessor requestPreprocessor,
                                                      OperationResponsePreprocessor responsePreprocessor,
                                                      Function<List<Snippet>, List<Snippet>> snippetFilter,
                                                      Snippet... snippets) {

    Snippet[] enhancedSnippets = enhanceSnippetsWithRaml(description, privateResource, snippetFilter, snippets);

    if (requestPreprocessor != null && responsePreprocessor != null) {
        return MockMvcRestDocumentation.document(identifier, requestPreprocessor, responsePreprocessor, enhancedSnippets);
    } else if (requestPreprocessor != null) {
        return MockMvcRestDocumentation.document(identifier, requestPreprocessor, enhancedSnippets);
    } else if (responsePreprocessor != null) {
        return MockMvcRestDocumentation.document(identifier, responsePreprocessor, enhancedSnippets);
    }

    return MockMvcRestDocumentation.document(identifier, enhancedSnippets);
}
 

import org.springframework.restdocs.snippet.Snippet; //导入依赖的package包/类
@Test
public void post() throws Exception {

    ConstrainedFields fields = new ConstrainedFields(FactTransactionJson.class);
    List<FieldDescriptor> fieldDescriptors = Descriptors.getFactFieldDescriptors("facts[].",
            fields);
    fieldDescriptors.add(0, fields.withPath("facts").description(
            "Non empty list with the facts to commit in this transaction"));
    Snippet requestFieldSnippet = requestFields(//
            fieldDescriptors);

    FactTransactionJson factTransactionJson = objectMapper.readValue(this.getClass()
            .getResourceAsStream("TransactionJson.json"), FactTransactionJson.class);

    final Response response = target("/transactions").register(documentationConfiguration(
            this.documentation))
            .register(document("facts-transactions", preprocessRequest(
                    removeHeaders("User-Agent"), prettyPrint()), preprocessResponse(
                            prettyPrint()), requestFieldSnippet))
            .request()
            .post(Entity.entity(
                    factTransactionJson, MediaType.APPLICATION_JSON));
    assertThat(response.getStatus(), is(204));

}
 

import org.springframework.restdocs.snippet.Snippet; //导入依赖的package包/类
@Test
public void getSimpleFact() {
    // links
    LinksSnippet links = HypermediaDocumentation.links(new HyperschemaLinkExtractor(), //
            HypermediaDocumentation.linkWithRel(Rel.SELF.getRelation().getName()).description(
                    "The link to that specific resource"));
    // payload
    List<FieldDescriptor> factFieldDescriptors = Descriptors.getFactFieldDescriptors("",
            new ConstrainedFields(FactJson.class));
    factFieldDescriptors.add(PayloadDocumentation.fieldWithPath("_schema").description(
            "Schemainformation"));
    Snippet responseDoc = PayloadDocumentation.responseFields(factFieldDescriptors);

    // header
    ResponseHeadersSnippet headerDoc = responseHeaders(headerWithName(HttpHeaders.CACHE_CONTROL)
            .description("Caching for 1000000 seconds."));

    final Response response = target("/facts/" + TestFacts.one.id().toString()).register(
            documentationConfiguration(this.documentation))
            .register(document("fact",
                    preprocessRequest(removeHeaders("User-Agent")), preprocessResponse(
                            prettyPrint()), links, responseDoc, headerDoc))
            .request()
            .get();
    assertThat(response.getStatus(), is(200));
    assertThat(response.getHeaderString(HttpHeaders.CACHE_CONTROL), is(
            "max-age=1000000, s-maxage=1000000, public"));
}
 

import org.springframework.restdocs.snippet.Snippet; //导入依赖的package包/类
private void verifySnippetInvocation(Snippet snippet, Map<String, Object> attributes, int times)
		throws IOException {
	ArgumentCaptor<Operation> operation = ArgumentCaptor.forClass(Operation.class);
	verify(snippet, Mockito.times(times)).document(operation.capture());
	assertThat(this.operationRequest, is(equalTo(operation.getValue().getRequest())));
	assertThat(this.operationResponse, is(equalTo(operation.getValue().getResponse())));
	assertThat(attributes, is(equalTo(operation.getValue().getAttributes())));
}
 

import org.springframework.restdocs.snippet.Snippet; //导入依赖的package包/类
private SectionSupport getSectionSnippet(Operation operation, String snippetName) {
    for (Snippet snippet : getDefaultSnippets(operation)) {
        if (snippet instanceof SectionSupport) {
            SectionSupport sectionSnippet = (SectionSupport) snippet;
            if (snippetName.equals(sectionSnippet.getFileName())) {
                return sectionSnippet;
            }
        }
    }

    return SnippetRegistry.getClassicSnippet(snippetName);
}
 

import org.springframework.restdocs.snippet.Snippet; //导入依赖的package包/类
protected static Snippet[] enhanceSnippetsWithRaml(String description,
                                                   boolean privateResource,
                                                   Function<List<Snippet>, List<Snippet>> snippetFilter,
                                                   Snippet... snippets) {

    List<RequestFieldsSnippet> requestFieldsSnippets = new ArrayList<>();
    List<ResponseFieldsSnippet> responseFieldsSnippets = new ArrayList<>();
    List<LinksSnippet> linkSnippets = new ArrayList<>();
    List<RequestParametersSnippet> requestParametersSnippets = new ArrayList<>();
    List<PathParametersSnippet> pathParametersSnippets = new ArrayList<>();

    List<Snippet> ramlSnippets = new ArrayList<>();

    List<Snippet> otherSnippets = new ArrayList<>();

    for (Snippet snippet : snippets) {
        if (snippet instanceof RequestFieldsSnippet) {
            requestFieldsSnippets.add((RequestFieldsSnippet) snippet);
        } else if (snippet instanceof ResponseFieldsSnippet) {
            responseFieldsSnippets.add((ResponseFieldsSnippet) snippet);
        } else if (snippet instanceof LinksSnippet) {
            linkSnippets.add((LinksSnippet) snippet);
        } else if (snippet instanceof RequestParametersSnippet) {
            requestParametersSnippets.add((RequestParametersSnippet) snippet);
        } else if (snippet instanceof PathParametersSnippet) {
            pathParametersSnippets.add((PathParametersSnippet) snippet);
        } else if (snippet instanceof RamlResourceSnippet) {
            ramlSnippets.add(snippet);
        } else {
            otherSnippets.add(snippet);
        }
    }

    List<Snippet> enhancedSnippets = new ArrayList<>();
    enhancedSnippets.addAll(requestFieldsSnippets);
    enhancedSnippets.addAll(responseFieldsSnippets);
    enhancedSnippets.addAll(linkSnippets);
    enhancedSnippets.addAll(requestParametersSnippets);
    enhancedSnippets.addAll(pathParametersSnippets);
    enhancedSnippets.addAll(otherSnippets);

    if (ramlSnippets.isEmpty()) { // No RamlResourceSnippet, so we configure our own based on the info of the other snippets
        RamlResourceSnippetParameters ramlParameters = RamlResourceSnippetParameters.builder()
                .description(description)
                .privateResource(privateResource)
                .requestFields(requestFieldsSnippets.stream().map(DescriptorExtractor::extract).flatMap(List::stream).toArray(FieldDescriptor[]::new))
                .responseFields(responseFieldsSnippets.stream().map(DescriptorExtractor::extract).flatMap(List::stream).toArray(FieldDescriptor[]::new))
                .links(linkSnippets.stream().map(DescriptorExtractor::extract).flatMap(List::stream).toArray(LinkDescriptor[]::new))
                .requestParameters(requestParametersSnippets.stream().map(DescriptorExtractor::extract).flatMap(List::stream).toArray(ParameterDescriptor[]::new))
                .pathParameters(pathParametersSnippets.stream().map(DescriptorExtractor::extract).flatMap(List::stream).toArray(ParameterDescriptor[]::new))
                .build();
        enhancedSnippets.add(ramlResource(ramlParameters));
    } else {
        enhancedSnippets.addAll(ramlSnippets);
    }

    enhancedSnippets = snippetFilter.apply(enhancedSnippets);

    return enhancedSnippets.toArray(new Snippet[0]);
}
 

import org.springframework.restdocs.snippet.Snippet; //导入依赖的package包/类
/**
 * Wraps the static document() method of RestDocs and configures it to pretty print request and
 * response JSON structures.
 */
protected RestDocumentationResultHandler document(String identifier, Snippet... snippets) {
  return MockMvcRestDocumentation.document(
      identifier, preprocessRequest(prettyPrint()), preprocessResponse(prettyPrint()), snippets);
}
 

import org.springframework.restdocs.snippet.Snippet; //导入依赖的package包/类
public RestDocumentationResultHandler documentPrettyPrint( String useCase, Snippet... snippets )
{
    return document( useCase, preprocessRequest( prettyPrint() ), preprocessResponse( prettyPrint() ), snippets );
}
 

import org.springframework.restdocs.snippet.Snippet; //导入依赖的package包/类
public static List<Snippet> getDefaultSnippets(Operation operation) {
    return (List<Snippet>) operation.getAttributes().get(ATTRIBUTE_NAME_DEFAULT_SNIPPETS);
}
 

import org.springframework.restdocs.snippet.Snippet; //导入依赖的package包/类
public static Snippet section() {
    return new SectionBuilder().build();
}
 

import org.springframework.restdocs.snippet.Snippet; //导入依赖的package包/类
public static Snippet authorization(String defaultAuthorization) {
    return new AuthorizationSnippet(defaultAuthorization);
}
 

import org.springframework.restdocs.snippet.Snippet; //导入依赖的package包/类
/**
 * Returns a json {@code Snippet} that will generate the WireMock stub from
 * the API operation.
 *
 * @see {@see MockMvcRestDocumentation}
 * @return the json snippet
 */
public static Snippet wiremockJson() {
	return new WireMockJsonSnippet();
}