The Debug view allows the interception of a message at various points of policy execution and thereby helps in analyzing/modifying the message at respective breakpoints.
After creating the API project and configuring/adding policies in its resource, click the Debug icon present on the menu bar to open the Debug view. This view is displayed only when a server group is selected or when the Gateway server in the server group selected is running and connected to the API Management server. If not, the Server group to debug dialog box appears. Select the Server Group where the project needs to be saved and deployed.
Figure 1: Dialog box to choose the Server Group in which the project needs to be deployed
In the Debug view, a preferred resource can be chosen from the Select a resource to debug drop-down list. After choosing the resource, the project policies and resource policies are displayed in its respective scopes (see Figure 1).
The message panel associated with the Server Group selected will be displayed at the bottom part of the screen.
This message panel reflects the variables configured in the Overview section.
Values can be added from the Message panel as well.
Adding Breakpoint
Right-click the route where the message has to be intercepted and click the Add Breakpoint option.
Figure 1: Adding breakpoint
The color of the route turns red representing the breakpoint.
Figure 2: Route on which breakpoint is set turning red
The refresh button resets the WSDL URL
The Send new message button helps to re-inject an edited message.
Debugging
To start debugging, first enter the missing values (values are entered in Figure 2) of parameters in the Message panel following the descriptions as provided in the Overview page. After entering the values, click the Send button present at the upper-right part of the Message Panel as shown in Figure 2. The message is intercepted at the first breakpoint and the route starts blinking in green. The message at that breakpoint is shown in the Response Message panel.
Figure 3: Route turning green in color and response message appearing below while debugging
In the Response message panel, the details can be edited. The Reset button present below the Send button helps to reset the changed details.
After sending messages from all the breakpoints or after every policy execution, the final response is sent to the App Endpoint which then turns green in color.
Figure 4: APP displayed in green font on receipt of the final response
Errors in Debugging
If an error occurs while executing a policy, the border of the policy node turns red and the debug process is stopped and response/error message is sent directly to App endpoint.
Figure 5: Border of the Policy node turning red indicating error in policy
If an error occurs in target end point, it turns red and the response/error message is sent directly to the App end point. The error message can be seen in the response message received.
Figure 6: TARGET displayed in red font indicating some error on target end point and error message displayed as response message
Ignored Policies
On execution, if the rules of the policy are not satisfied, the policy is ignored and its border turns orange as shown in the figure above. The policy details of the ignored policy are shown in the figure below.
Policy Details panel
Click the policy node to view the policy details.
Click the green colored route (if it appears) to continue the debugging process.
Click the green colored API endpoint (if debugging is over) to view the response message.
Click the Reinjecting Message icon to restart the debugging.
Figure 7: Policy Details
Removing Breakpoint
Right-click the route in which the breakpoint is set and select Remove Breakpoint.
The route color turns to the default color.
Figure 8: Remove Breakpoint option to remove the breakpoint set
JavaScript errors detected
Please note, these errors can depend on your browser setup.
If this problem persists, please contact our support.
