Versions Compared

Old Version 12

changes.mady.by.user Justin

Saved on

compared with

New Version Current

changes.mady.by.user Aadrian Zarin

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • Add the project dependency below:

    Code Block
    languagexml
    <!-- 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

...

Panel
borderColorgrey

To generate JSON APIs from your implementation, see the available Java annotations with samples below:

@Operation

Variable

Data TypeMandatoryDescription
pathString

(tick)

API path name to call the method. Always start with a forward slash ( / ).

To include path parameters, after annotating @Param with the method parameter (see doc below), you can add the variable enclosed within curly braces into the path.

Example: 

Panel

/getUserDetails

/getUserDetails/{username}

typeenum

Defines the request method type.

Available types:

  • Operation.MethodType.GET
  • Operation.MethodType.POST
  • Operation.MethodType.PUT
  • Operation.MethodType.DELETE

Default value when undefined is Operation.MethodType.POST.

summaryString

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.

descriptionString

A verbose description of the operation.

Default value when undefined is a blank string.

deprecatedboolean

Allows an operation to be marked as deprecated.

Default value when undefined is false.

@Responses

Consists of @Response annotation(s). Information in table here:

Variable

Data TypeMandatoryDescription
responseCodeint

(tick)

The HTTP response code.

Example value: 

Panel

200

descriptionString

A short description of the response.

Default value when undefined is a blank string.

definitionString

A definition to the data schema in response.

Default value when undefined is a blank string.

dataClassString

A class to the data in response.

Default value when undefined is a blank string.

contentTypeString

A content type of the data in response.

Default value when undefined is "application/json".

arrayboolean

Defines if this response value is an array.

Default value when undefined is false.

@Param

Variable

Data TypeMandatoryDescription
valueString

(tick)

A short name of the parameter.

Example value: 

Panel

username

requiredboolean

Defines if this parameter value is mandatory.

Default value when undefined is true.

descriptionString

A verbose description of the parameter.

Default value when undefined is a blank string.

definitionString

The key of definition provided by ApiPlugin.

Example value:

Panel

ApiResponse

Default value when undefined is a blank string.

headerboolean

Defines if this parameter value is in the request header.

Default value when undefined is false.


For detailed examples, do check out the Sample Plugins attached in this page.

Here is a sample code snippet from the sample Basic Current User API plugin:

Code Block
languagejava
@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()));
    }
}

...

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

...