org.springframework.restdocs.hypermedia.LinksSnippet Java Examples

The following examples show how to use org.springframework.restdocs.hypermedia.LinksSnippet. You can vote up the ones you like or vote down the ones you don't like, and go to the original project or source file by following the links above each example. You may check out the related API usage on the sidebar.
Example #1
Source File: BaseDocumentation.java    From spring-cloud-skipper with Apache License 2.0 5 votes vote down vote up 
/**
 * {@link LinksSnippet} for common links. Common links are set to be ignored.
 *
 * @param descriptors Provide addition link descriptors
 * @return the link snipped
 */
public static LinksSnippet linksForSkipper(LinkDescriptor... descriptors) {
	return HypermediaDocumentation.links(
			linkWithRel("self").ignored(),
			linkWithRel("first").ignored().optional(),
			linkWithRel("next").ignored().optional(),
			linkWithRel("last").ignored().optional(),
			linkWithRel("profile").ignored(),
			linkWithRel("search").ignored(),
			linkWithRel("deployer").ignored().optional(),
			linkWithRel("curies").ignored().optional()).and(descriptors);
}
Example #2
Source File: DescriptorExtractor.java    From restdocs-raml with MIT License 5 votes vote down vote up 
public static List<LinkDescriptor> extract(LinksSnippet snippet) {
    try {
        Method getDescriptorsByRel = LinksSnippet.class.getDeclaredMethod("getDescriptorsByRel");
        getDescriptorsByRel.setAccessible(true);
        return new ArrayList<>(((Map<String, LinkDescriptor>) getDescriptorsByRel.invoke(snippet)).values());
    } catch (NoSuchMethodException | InvocationTargetException | IllegalAccessException e) {
        e.printStackTrace();
    }
    return emptyList();
}
Example #3
Source File: DescriptorExtractorTest.java    From restdocs-raml with MIT License 5 votes vote down vote up 
@Test
public void should_extract_link_descriptors() {
    // given
    LinksSnippet snippet = links(
        linkWithRel("self").description("Is documented!")
    );

    // when
    List<LinkDescriptor> descriptors = extract(snippet);

    then(descriptors).hasSize(1);
    then(descriptors.get(0).getRel()).isEqualTo("self");
    then(descriptors.get(0).getDescription()).isEqualTo("Is documented!");
}
Example #4
Source File: RamlDocumentation.java    From restdocs-raml with MIT License 4 votes vote down vote up 
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<RequestHeadersSnippet> requestHeadersSnippets = new ArrayList<>();
    List<ResponseHeadersSnippet> responseHeadersSnippets = 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 RequestHeadersSnippet) {
            requestHeadersSnippets.add((RequestHeadersSnippet) snippet);
        } else if (snippet instanceof ResponseHeadersSnippet) {
            responseHeadersSnippets.add((ResponseHeadersSnippet) 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(requestHeadersSnippets);
    enhancedSnippets.addAll(responseHeadersSnippets);
    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))
                .requestHeaders(requestHeadersSnippets.stream().map(DescriptorExtractor::extract).flatMap(List::stream).toArray(HeaderDescriptor[]::new))
                .responseHeaders(responseHeadersSnippets.stream().map(DescriptorExtractor::extract).flatMap(List::stream).toArray(HeaderDescriptor[]::new))
                .build();
        enhancedSnippets.add(ramlResource(ramlParameters));
    } else {
        enhancedSnippets.addAll(ramlSnippets);
    }

    enhancedSnippets = snippetFilter.apply(enhancedSnippets);

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