Package org.springframework.restdocs.snippet

Interface Snippet

All Known Implementing Classes:
AbstractBodySnippet, AbstractFieldsSnippet, AbstractHeadersSnippet, AbstractParametersSnippet, CurlRequestSnippet, HttpieRequestSnippet, HttpRequestSnippet, HttpResponseSnippet, LinksSnippet, PathParametersSnippet, RequestBodySnippet, RequestFieldsSnippet, RequestHeadersSnippet, RequestParametersSnippet, RequestPartBodySnippet, RequestPartFieldsSnippet, RequestPartsSnippet, ResponseBodySnippet, ResponseFieldsSnippet, ResponseHeadersSnippet, TemplatedSnippet
public interface Snippet
A Snippet is used to document aspects of a call to a RESTful API.
Author:
Andy Wilkinson

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    document(Operation operation)
    Documents the call to the RESTful API described by the given operation.

  • Method Details

    • document

      void document(Operation operation) throws IOException
      Documents the call to the RESTful API described by the given operation.
      Parameters:
      operation - the API operation
      Throws:
      IOException - if a failure occurs will documenting the operation