Add the project dependency below:
<dependency>
<groupId>org.joget.api</groupId>
<artifactId>apibuilder_api</artifactId>
<version>${project.version}</version>
<scope>provided</scope>
</dependency> |
public boolean authenticate(HttpServletRequest request, HttpServletResponse response);
Used to authenticate API calls on an existing API document.
Parameters:
request - the http request information
response - the http response to write
public String getTagDesc();
Return a tag description for API Document.
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.
public String getExternalDocsDesc();
Return a short description for external document for API document.
Default value is NULL.
public String getExternalDocsURL();
Return a link for external document for API document generation.
Default value is NULL.
public Map<String, ApiDefinition> getDefinitions();
Return a key & JSON Definition map for API document generation.
Default value is NULL.
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".
public Map<String, String> getOperationOptions();
Return a map of available operations (GET, POST, PUT, DELETE) to populate in builder.
public boolean usingSimpleConfig();
A flag to indicate using simplified plugin configuration method.
Default value is TRUE.