Usages
- API Element Plugin is used as an extension of functions on top of the default API elements available in the API Builder.
- This plugin type must extend org.joget.api.model.ApiPluginAbstract abstract class.
POM file adjustments
Add the project dependency below:
<dependency> <groupId>org.joget.api</groupId> <artifactId>apibuilder_api</artifactId> <version>${project.version}</version> <scope>provided</scope> </dependency>
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.
API Methods
To generate JSON APIs from your implementation, see the available Java annotations with samples below:
@Operation
Variable | Data Type | Mandatory | Description |
|---|---|---|---|
| path | String |
| API path name to call the current method. Always starts with a forward slash ( / ). Example: /getUserDetails |
| type | enum | Defines the request method type. Available types:
Default value when undefined is Operation.MethodType.POST. | |
| summary | String | Provides a brief description of this operation. This is the value to display as the method name in the API Builder. Recommended to be 120 characters or less for proper visibility when previewing API. Default value when undefined is a blank string. | |
| description | String | A verbose description of the operation. Default value when undefined is a blank string. | |
| deprecated | boolean | Allows an operation to be marked as deprecated. Default value when undefined is false. |
@Responses
public String getIcon()
Return the icon to show for this API Element in the API Builder palette.
@Param
public String getIcon()
Return the icon to show for this API Element in the API Builder palette.
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.
Sample Plugins
Basic Current User API - basic-current-user.zip
Sample API with property options - apibuilder_sample_plugin.zip