In the Service panel resides a folder API where you can define your own service APIs.

Designer > Modeling APIs > api_folder.png

Go to the API folder in the service panel of your service.

Designer > Modeling APIs > add_rest_api.png

First you need to create the API needed for your service inside the API folder. All other elements will be created within this API. Add a new API via the quick action or the context menu. Refer to API for more information on how to create a new API in the API folder.

API Elements

To define a service API, you have the following elements available:

Element					Description	Details
API						API
	Port					Port
		Class				Class
			Class		Classes can have sub-classes.
			Operation			Operation
				Parameter		Parameter
		Interface				Interface
			Interface		Interfaces can have sub-interfaces and sub-classes.
			Class		Interfaces can have sub-interfaces and sub-classes.
			Operation		Operations and parameters for interfaces are the same as for classes. The difference is that they have no implementation but only define the signature for the dependent classes to derive from.	Operation
				Parameter		Parameter

Each element of the API folder has a context menu and quick actions. The context menu contains options to create new elements to the selected element, and to edit the current element. Via the quick actions, you can access the most used menu items directly with a single click.

API

Designer > Modeling APIs > api_quick_action.png

The quick action of an API allows for the creation of ports.

Quick Action	Description
	Add a port to the API.

Designer > Modeling APIs > api_cm.png

The context menu of an API allows you to create a port, to cut, copy and paste the API, to change the name of the API, and to delete it.

Menu Item	Description
Add Port	Add a port to the API
Cut	Cut the API to paste it elsewhere to the API folder.
Copy	Copy the API to paste it elsewhere to the API folder.
Paste	Paste the API elsewhere to the API folder. Available if Copy or Cut option have been used before.
Rename	Change the API name.
Delete	Delete the API.

Port

Designer > Modeling APIs > port_cm.png

The context menu of a port allows for the creation of classes and interfaces, to change the name of the port, and to delete it.

Menu Item	Description
Add Class	Add a class to the port.
Add Interface	Add an interface to the port.
Rename	Change the port name.
Delete	Delete the port.

Class

Designer > Modeling APIs > api_class_quick_actions.png

The quick actions of a class allow for the creation of operations with different types of implementation.

Quick Action	Description

Designer > Modeling APIs > api_class_cm.png

The context menu of a class allows you to create further elements, to cut, copy and paste the class, to change the name of the class, and to delete it.

Menu Item	Description
Add Class
Add Interface
Add Operation
Cut
Copy
Paste
Rename
Delete

Operation

	The quick actions of an operation allow for the creation of parameters with different directions, and to jump to the implementation of the operation.
	The context menu of an operation allows you to create further elements, to select and change the type of implementation of the operation and to open the implementation of the operation. Furthermore you can cut, copy and paste the operation, change the name of the operation, and delete it via this menu.

Parameter

Designer > Modeling APIs > api_parameter_cm.png

The context menu of a parameter allows you to change the order of parameters as well as to change the names of a parameter. Furthermore you can cut, copy and paste a parameter. It is not possible to create further elements below a parameter.

If you want to change the direction of a parameter, select the parameter and change attribute Direction in the Attributes panel:

Designer > Modeling APIs > parameter_direction.png

Interface

	The quick action of an interface allows for the creation of operations.
	The Interface context menu allows you to create further elements and to change the name of the interface. Furthermore you can cut, copy and paste as well as delete the interface via this menu.