Interface APIProvider


public interface APIProvider

This interface exposes documentation for a RESTful endpoint.

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static enum 
     
  • Method Summary

    Modifier and Type
    Method
    Description
    This method exposes the documentation for a certain RESTful endpoint.
  • Method Details

    • getDocument

      String getDocument(APIProvider.DocType docType)
      This method exposes the documentation for a certain RESTful endpoint. The returned String can be a serialized document, usually JSON or YAML, or a file reference (starting with file:///) or a URL reference (starting with http:// or https://).
      Parameters:
      docType - an item from APIProvider.DocType
      Returns:
      a String representing either the serialized document or a reference to the document, or null if the DocType is not supported.