Page History

...

• Add the project dependency below:

  Code Block
  language xml
  <!-- Add apibuilder_api dependency --> <dependency> <groupId>org.joget.api</groupId> <artifactId>apibuilder_api</artifactId> <version>${project.version}</version> <scope>provided</scope> </dependency>

  Info
  You can get the apibuilder_api.jar at https://download.joget.org/addons/for_plugin_developer/

Abstract Class

org.joget.api.model.ApiPluginAbstract

• Under apibuilder_api module
• Extended org.joget.plugin.base.ExtDefaultPlugin. Please refer to Plugin Base Abstract Class and Interface.
• Implemented org.joget.api.model.ApiPlugin.
• A base abstract class to develop a custom API Element Plugin.

Abstract Methods

authenticate

public boolean authenticate(HttpServletRequest request, HttpServletResponse response);

Used to authenticate API calls on an existing API document.

Parameters:

request - the http request information

...

API Methods

@Operation(
        path = "/getUserDetails",
        type = Operation.MethodType.GET,  
        summary = "Get user details",
        description = "Get user details via username, else get current user."
    )
@Responses({
    @Response(responseCode = 200, description = "Success", definition = "User"),
    @Response(responseCode = 404, description = "User data not found", definition = "ApiResponse")
})
public ApiResponse getUserDetails(
        @Param(value = "username", required = false, description = "Username of user.") String username) {
    ExtDirectoryManager dm = (ExtDirectoryManager) AppUtil.getApplicationContext().getBean("directoryManager");
    User user = dm.getUserByUsername(username);
    WorkflowUserManager wum = (WorkflowUserManager) AppUtil.getApplicationContext().getBean("workflowUserManager");
    User currentUser = wum.getCurrentUser();
    if (user != null) {
        return new ApiResponse(200, user, getFields());
    } else if (user == null && currentUser != null) {
        return new ApiResponse(200, currentUser, getFields());
    } else {
        return new ApiResponse(404, AppPluginUtil.getMessage("BasicCurrentUserAPI.resp.404", getClassName(), getResourceBundlePath()));
    }
}

Abstract Methods

getIcon

public String getIcon()

Return the icon to show for this API Element in the API Builder palette.

getTag

public String getTag()

Return a unique tag for the API Document.

Overridable Methods

getTagDesc

public String getTagDesc();

...

Return a tag description for

...

API

...

Document.

Default will return the value found in getLabel() method in your custom plugin.

getResourceBundlePath

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 method
...
.
Default value is 
...
TRUE.
Plugin Properties Options
Please refer to Plugin Properties Options for more information.
 Anchor
samplePlugins
samplePlugins
Sample Plugins
Basic Current User API
...
basic-current-user.zip
Sample API with property options
...
apibuilder_sample_plugin.zip