Define REST API Endpoint Group

We will use Create Customer as a sample to define the REST API Endpoint Group.

1. Go to the ##RestEndpointGroup worksheet. AlchemyJ Workbook can support multiple REST API Endpoint Groups worksheets.
2. In the Basic Settings section, key in the values as shown below for the basic settings. This defines the endpoint group name.

Item	Value
Endpoint group	CustomerService
Endpoint group path	/customers

3. Next, we define the function point Create Customer. In the Function Points section (for output & declaration of function), key in the values as shown below. For REST API, the output must be an object defined in the Data Relationship Schema.

Function Point	Path	Operation	Response Data Address	Response File Address	DB Operation Type
Create Customer	/customer	POST	CreateCustomer!B21:L24		Transactional

The Response Data Address is the output data relationship schema which is defined in the business logic sheet

4. In the Input Parameters section, key in the values as shown below. The input is an object and the Data Address is the output data relationship schema which is defined in the business logic sheet.

Function Point	Style	Name	Data Type	Data Address	Required
Create Customer	Request body	customer	Object	CreateCustomer!B15:L18	Yes

5. In Related Worksheets Section, add all the effective ranges used in this API.

Worksheet Effective Range
CreateCustomer'!B1:L24
DataDictionary'!A1:AJ21

6. Done! All the settings are shown below.