Using API Inspector

When you find the API does not behave as expected, AlchemyJ provides API Inspector for you to check the intermediate result from API Inspector for troubleshooting.

Add Inspector Setting

1. Go to the AlchemyJ toolbar, click the Inspector Settings in the Troubleshoot tab.

2. A new worksheet ##InspectorSetting will be appended to your current workbook. In the ##InspectorSetting, each section represents an inspector action.

   

   Refer to API Inspector Settings for more details.

Define and Activate Inspector Setting

In this tutorial, we take the Sample REST API for example, it is going to enable the debug excel file and check the request parameter of the sample REST API.

1. Specify the debug excel path in the Generate API Inspector Excel File section. Input the function name and set the Disable column to 'No'. ]

2. Specify the function point name in the View Request Parameter section and set the Disable column to 'No'. ]

3. Go to the AlchemyJ toolbar, click the Activate Inspector Settings in the Troubleshoot tab. AlchemyJ will generate a JSON according to the defined inspector settings.

  [
   {
       "action": "generate-debug-excel",
       "parameters": {
           "functionPoint": "Function Point 1",
           "folderPath": "D:\\Temp"
       }
   },
   {
       "action": "view-req-params",
       "parameters": {
           "functionPoint": "Function Point 1"
       }
   }
  ]

Enable the Debugging Mode

1. Go to the AlchemyJ toolbar, click on Properties.

2. Go to the API Generation tab on the dialog box. Select Debug on the Compilation mode.

   

3. Compile and run the project in debug mode.

Launch API Inspector

1. Go to the AlchemyJ toolbar, click the API Inspector. The AlchemyJ API Inspector Console will be launched and the default listening port is 9898. You can update the port number in the AlchemyJ Properties if needed.

   

2. Run the function point API function from the browser.

   

3. You can see the request parameter and the debug excel file path information are shown in the inspector console.