Open source platform to develop plugins for Katalon Studio
Clone or download
duyluonganh Merge pull request #24 from katalon-studio/dev
 Fix could not load menu item extension
Latest commit 44c9d45 Jan 17, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
com.katalon.platform Fix could not load menu item extension Jan 17, 2019
docs/turorials Update create-your-first-plugin.md Jan 17, 2019
.gitignore remove ignored files Dec 18, 2018
LICENSE add LICENSE Dec 18, 2018
README.md Fix create-your-first-plugin.md Jan 17, 2019
pom.xml Update to 1.0.5 Jan 16, 2019

README.md

Katalon Studio Platform

This open source platform is for developing Katalon Studio plugins.

Basic Concepts

Plugins

Each Katalon Studio plugin is a Maven-based Java project.

A plugin can contribute functions to Katalon Studio through its extensions.

Extensions and Extension Points

An extension point is an area where plugins can contribute functions to Katalon Studio. Each function is called an extension.

Extensions are defined in the plugin.xml file.

<extension point="com.katalon.platform.extensions">
    <point
        id="com.example.my_extension_id"
        extensionPointId="id_of_the_extension_point"
        implementationClass="com.example.MyExtensionClassImpl">
    </point>
</extension>

Package structure

com.katalon.platform.api.*: Contains extension points and APIs for interacting with Katalon Studio.

com.katalon.platform.internal.*: Internal packages that should not be used directly by plugins.

Getting started

Create your first Katalon Studio plugin

Build

Requirements:

  • JDK 1.8
  • Maven 3.3+

mvn clean install

Test Javadoc

mvn javadoc:javadoc