Capture the Composed REST Request for Debugging

See more REST Examples

Demonstrates Rest.GetLastDebugRequest, which copies the fully composed HTTP request (request line, headers, and body) into a BinData. The example builds a two-part multipart request so the captured output shows the multipart boundaries, part headers, and part bodies. This works when the DebugMode property was enabled while the request was composed.

import sys
import chilkat

success = False

rest = chilkat.CkRest()
bTls = True
bAutoReconnect = True
success = rest.Connect("example.com",443,bTls,bAutoReconnect)
if (success == False):
    print(rest.lastErrorText())
    sys.exit()

#  Enable debug mode so the fully composed HTTP request is captured instead of being sent.
rest.put_DebugMode(True)

#  Build a multipart request with two parts.  The captured debug output will show the multipart
#  boundaries, part headers, and part bodies.
rest.put_PartSelector("1")
rest.AddHeader("Content-Type","text/plain")
rest.AddHeader("Content-Disposition","form-data; name=\"field1\"")
success = rest.SetMultipartBodyString("value1")
if (success == False):
    print(rest.lastErrorText())
    sys.exit()

rest.put_PartSelector("2")
rest.AddHeader("Content-Type","application/json")
rest.AddHeader("Content-Disposition","form-data; name=\"metadata\"")
success = rest.SetMultipartBodyString("{ \"active\": true }")
if (success == False):
    print(rest.lastErrorText())
    sys.exit()

#  Compose the multipart request.  In debug mode the request is built but not transmitted.
success = rest.SendReqMultipart("POST","/api/upload")
if (success == False):
    print(rest.lastErrorText())
    sys.exit()

#  Copy the composed request (request line, headers, and multipart body that would be sent) into a
#  BinData, then view it as text.
bdRequest = chilkat.CkBinData()
rest.GetLastDebugRequest(bdRequest)

requestText = bdRequest.getString("utf-8")
if (bdRequest.get_LastMethodSuccess() == False):
    print(bdRequest.lastErrorText())
    sys.exit()

print(requestText)