APIM - Debug mode

[mouligno]

Global presentation

Debug mode is the second step of the try it mode.

Based on the same behavior, trying a call in studio before deploying it. You can choose path, verb, add headers and body in order to view if your designed API is working as expected.

In debug mode, we introduce display of all policies used in a timeline so you can view the order of execution and input/output of each.

Different state for policies :

• executed
• skipped (based on a condition Conditional policies #635 )
• error

You can view input and output of each policy, header/body.
You can view if there was an addition/edition/deletion of header/body

Timeline - how to interpret ?

Regarding the policy timeline, the order may not be the same than what's been designed in policy studio.

The debug mode keep the gateway execution order (request header > request body > response header > response body) and a policy could appear twice if it implies works on both header and body.
This gateway execution policy order is made that way for performance purpose.

Limitations

• Context-path - as we're building specific instance of your call to help you debug it, the context-path accessible through attributes from Expression language {#context.attributes['context-path']} would include an event id
• Rate Limit & quota policies - for the same reason, you won't be able to trigger that kind of behavior
• Spike arrest
• Cache - cache policy will not be testable through debug mode with in memory cache: it is created and destroyed with the api
• IPFiltering - call being executed by the gateway, you won't be able to IPFiltering your IPs directly in the debug session (IP used for the call would be 127.0.0.1)

[plsstephenson]

Try it mode is documented here: https://docs.gravitee.io/apim/3.x/apim_publisherguide_design_studio_try_it.html