Post-processing

Post-processing refers to any user-defined processes performed on the default endpoint output after the main API process has been executed.

Post-processing settings

Post-processes are broken down into blocks. You may define any number of processing blocks, which will be executed in a series based on the order of definition.
Each block takes the results of the execution of the previous block as input. Click [Add] to append a new empty block at the end of the series.

Block types

Currently, Kuroco supports three types of blocks:

See below for the details of each type.

Allow list

The allow list is a simple field filter. A list or details API returns a lot of information, some of which you may wish to make optional or hidden from users.

You can think of it as a whitelist: only the fields you set here will be returned. Therefore, you should list all the fields used by your front-end application.

Field settings

Specify the full path to the field in the JSON output, starting from the root. Skip over arrays and only specify objects - the filter will be applied to all objects in an array.

Example scenario

{
  "list": [
    {
      "subject": "First article",
      "contents": "The contents of the first article",
      "sponsors": ["Company X"]
    },
    {
      "subject": "Second article",
      "contents": "The contents of the second article",
      "sponsors": ["Company Y"]
    }
  ],
  "pageInfo": {
    "totalCnt": 7,
    "pageNo": 1,
    ...
  }
}

For example, in the above sample code, we would like to remove sponsors only.

The three fields we are keeping, including all root and child fields, are:

• list.subject
• list.contents
• pageInfo

Your configuration should look like this:

The drawback to this simple filter is a lack of flexibility. If you need more in-depth customization, see Convert list and Custom function.

Convert list

This block allows you to add processes to each field by choosing among available options.

Click [Add field] to add a sub-block defining a process for a specific field. Note the two different [Delete] functions in this block: the one to the right (a) deletes the corresponding sub-block row, while the one at the bottom (b) deletes the entire block.

Field settings

Transformation processes

Example scenario

Consider the same sample code as before:

{
  "list": [
    {
      "subject": "First article",
      "contents": "The contents of the first article",
      "sponsors": ["Company X"]
    },
    {
      "subject": "Second article",
      "contents": "The contents of the second article",
      "sponsors": ["Company Y"]
    }
  ],
  "pageInfo": {
    "totalCnt": 7,
    "pageNo": 1,
    ...
  }
}

Suppose you want to add a new field called title, which contains the uppercase version of the contents of subject. Configure your field settings as follows:

Your configuration should look like this:

New output:

{
"list":
  [
    {
      "subject": "First article",
      "contents": "The contents of the first article",
      "sponsors": [
        "Company X"
      ],
      "title": "FIRST ARTICLE"
    },
    {
      "subject": "Second article",
      "contents": "The contents of the second article",
      "sponsors": [
        "Company Y"
      ],
      "title": "SECOND ARTICLE"
    }
  ],
"pageInfo":
  {
    "totalCnt": 7,
    "pageNo": 1
  }
}

Custom function

If your API requires more in-depth features, write a custom function defining how your data should be transformed and link it to your endpoint.

Custom function creation

To avoid confusion with custom functions used in other modules, we recommend setting it up as follows:

• Create a custom function category dedicated to post-processing in advance and set it as the category of the function.
• Match the title of the custom function with the path name of the endpoint.

Linking the function to the target endpoint

1. In the left sidebar menu, click [API] and select the target endpoint list screen.
2. Select the target endpoint from the list and click [Post-processing].
3. In the dropdown list, select [Custom function] and choose the correct category and function name (list).
4. Click [Save].

Example configuration:

Post-processing variables

The variables used in post-processing contain reserved words with specific meanings. You can customize the endpoint behavior using these variables.

When in trouble

If a post-process is not working as expected, verify the following:

• The post-processing custom function has been linked properly.
• You have linked the correct custom function.
• The variable name is correct.
• The variable data is stored in the correct format.
• The custom function contains no syntax errors.