Package com.ibm.wsspi.rest.api.discovery
Interface APIProvider
-
public interface APIProvider
This interface exposes documentation for a RESTful endpoint.
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static class
APIProvider.DocType
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.lang.String
getDocument(APIProvider.DocType docType)
This method exposes the documentation for a certain RESTful endpoint.
-
-
-
Method Detail
-
getDocument
java.lang.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 fromAPIProvider.DocType
- Returns:
- a String representing either the serialized document or a reference to the document, or null if the DocType is not supported.
-
-