Package org.springframework.restdocs.hypermedia

Interface LinkExtractor

public interface LinkExtractor
A LinkExtractor is used to extract links from a JSON response. The expected format of the links in the response is determined by the implementation.
Author:
Andy Wilkinson

  • Method Summary

    Modifier and Type
    Method
    Description
    Map<String,List<Link>>
    extractLinks(OperationResponse response)
    Extract the links from the given response, returning a Map of links where the keys are the link rels.

  • Method Details

    • extractLinks

      Map<String,List<Link>> extractLinks(OperationResponse response) throws IOException
      Extract the links from the given response, returning a Map of links where the keys are the link rels.
      Parameters:
      response - the response from which the links are to be extracted
      Returns:
      the extracted links, keyed by rel
      Throws:
      IOException - if link extraction fails