Developers can view full REST calls and responses

Description

Currently, if a REST call fails a developer has no information about the REST call, and does not even necessarily know if it failed.

It's tricky for a developer because the problem could be in many places:  in the restclient definition, or it could be with the external service itself, or it could be in the FTL or in the App configuration. Its easy to introduce a problem in the call since the calls themselves are often dynamically constructed.

Acceptance Criteria:

  • An error while making a REST call should be written to the log.

    • Dedicated log file?

  • All details about the request and response should be included - body, cookies, headers, parameters. 

  • Secure information should not be written to the log.

Additional ideas for later:

  • Secure info is only written when the server is in developer mode.

  • If call can be written in a format compatible with 'curl' that is a bonus, because then developers could try it.

Attachments

1

Activity

Show:

Dai Ha February 5, 2020 at 9:20 AM

Solution

Add a new Debug subapp to Rest Client app as below

To monitoring requests/responses, select definitions from Available Definition columns, keep the subapp opens during debug session. Closing the Debug subapp after debug session is necessary for data cleanup as well as data confidential reason. For each of call, there will be an entry in Debug Content dropdown. Select one entry will populate string content of that request/response to underneath tabsheets. For more usage detail, refer to Rest Client App documentation.

Christopher Zimmermann February 4, 2020 at 7:11 AM

Please add a comment describing how to use this feature, or what was done.

Fixed

Details

Assignee

Reporter

Priority

Fix versions

Story Points

Sprint

More fields

Created October 21, 2019 at 3:12 PM
Updated February 19, 2020 at 7:05 AM
Resolved January 22, 2020 at 7:53 AM