...
public String getTagDesc();
Used to add Return a tag description for the API tagDocument.
Default will return the value found in getLabel() method in your custom plugin.
...
public String getResourceBundlePath();Return a resource bundle path for API document generation.
Default value is NULL.
getExternalDocsDesc
public String getExternalDocsDesc();Return a short description for external document for API document.
Default value is NULL.
getExternalDocsURL
public String getExternalDocsURL();Return a link for external document for API document generation.
Default value is NULL.
getDefinitions
public Map<String, ApiDefinition> getDefinitions();Return a key & JSON Definition map for API document generation.
Default value is NULL.
isAPIEnabled
public Boolean isAPIEnabled(String method, String path);Check if an API path is enabled for the API Key.
Default behavior will check if method exist in the specified path, in the property string "ENABLED_PATHS".
getOperationOptions
public Map<String, String> getOperationOptions();Return a map of available operations (GET, POST, PUT, DELETE) to populate in builder.
usingSimpleConfig
public boolean usingSimpleConfig();A flag to indicate using simplified plugin configuration methodUsed to authenticate API calls on an existing API document.
Default value is nullTRUE.
Plugin Properties Options
...