Versions Compared

Old Version 9

changes.mady.by.user Justin

Saved on

compared with

New Version 10

changes.mady.by.user Justin

Saved on

Key

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

...

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

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

@Operation

Variable

Data TypeMandatoryDescription
Default ValuePath
pathString

(tick)

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

Example: 

Panel

/getUserDetails

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
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