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.

Dim success As Boolean = False

Dim rest As ChilkatRest
rest.Initialize("rest")
Dim bTls As Boolean = True
Dim bAutoReconnect As Boolean = True
success = rest.Connect("example.com", 443, bTls, bAutoReconnect)
If success = False Then
    Log(rest.LastErrorText)
    Return
End If


'  Enable debug mode so the fully composed HTTP request is captured instead of being sent.
rest.DebugMode = True

'  Build a multipart request with two parts.  The captured debug output will show the multipart
'  boundaries, part headers, and part bodies.
rest.PartSelector = "1"
rest.AddHeader("Content-Type", "text/plain")
rest.AddHeader("Content-Disposition", "form-data; name=" & Chr(34) & "field1" & Chr(34))
success = rest.SetMultipartBodyString("value1")
If success = False Then
    Log(rest.LastErrorText)
    Return
End If


rest.PartSelector = "2"
rest.AddHeader("Content-Type", "application/json")
rest.AddHeader("Content-Disposition", "form-data; name=" & Chr(34) & "metadata" & Chr(34))
success = rest.SetMultipartBodyString("{ " & Chr(34) & "active" & Chr(34) & ": true }")
If success = False Then
    Log(rest.LastErrorText)
    Return
End If


'  Compose the multipart request.  In debug mode the request is built but not transmitted.
success = rest.SendReqMultipart("POST", "/api/upload")
If success = False Then
    Log(rest.LastErrorText)
    Return
End If


'  Copy the composed request (request line, headers, and multipart body that would be sent) into a
'  BinData, then view it as text.
Dim bdRequest As ChilkatBinData
bdRequest.Initialize
rest.GetLastDebugRequest(bdRequest)

Dim requestText As String = bdRequest.GetString("utf-8")
If bdRequest.LastMethodSuccess = False Then
    Log(bdRequest.LastErrorText)
    Return
End If

Log(requestText)