Swift

curl with Variable Substitution in an XML Request Body

See more CURL Examples

This example shows how to use variables inside an XML request body using the {{variable_name}} syntax. When the HTTP request’s Content-Type indicates XML, Chilkat automatically applies proper XML entity encoding to each substituted value, ensuring the resulting XML remains valid. Swift

func chilkatTest() {
    var success: Bool = false

    // Variable names are enclosed between {{ and }}

    // curl -X POST https://api.example.com/api/orders \
    //   -H "Content-Type: application/xml; charset=utf-8" \
    //   -H "Accept: application/xml" \
    //   -d '<order>
    //   <customerName>{{customer_name}}</customerName>
    //   <note>{{note}}</note>
    //   <address>{{address}}</address>
    //   <instructions>{{instructions}}</instructions>
    // </order>'

    let sbCurl = CkoStringBuilder()!
    sbCurl.appendLn(str: "curl -X POST https://api.example.com/api/orders \\")
    sbCurl.appendLn(str: "  -H \"Content-Type: application/xml; charset=utf-8\" \\")
    sbCurl.appendLn(str: "  -H \"Accept: application/xml\" \\")
    sbCurl.appendLn(str: "  -d '<order>")
    sbCurl.appendLn(str: "  <customerName>{{customer_name}}</customerName>")
    sbCurl.appendLn(str: "  <note>{{note}}</note>")
    sbCurl.appendLn(str: "  <address>{{address}}</address>")
    sbCurl.appendLn(str: "  <instructions>{{instructions}}</instructions>")
    sbCurl.appendLn(str: "</order>'")

    let curl = CkoHttpCurl()!

    // The values below contain chars that will require XML entity encoding.  
    // Chilkat will automatically do the encoding because the Content-Type of this request is "application/xml"
    curl.setVar(varName: "customer_name", varValue: "John & Sons")
    curl.setVar(varName: "note", varValue: "He said \"Ship it ASAP!\"")
    curl.setVar(varName: "address", varValue: "123 <Main> Street")
    curl.setVar(varName: "instructions", varValue: "Use door #2 & call upon arrival")

    // To demonstrate how the variables are replaced, this example does not execute the curl command. 
    // Instead, it generates the raw HTTP request that would be sent if the curl command were run.
    let sbRawRequest = CkoStringBuilder()!
    success = curl.toRawRequest(curlCommand: sbCurl.getAsString(), sb: sbRawRequest)
    if success == false {
        print("\(curl.lastErrorText!)")
        return
    }

    print("\(sbRawRequest.getAsString()!)")

    // The output is shown below.
    // Notice the chars that were XML entity encoded.

    // POST /api/orders HTTP/1.1
    // Accept: application/xml
    // Host: api.example.com
    // Content-Type: application/xml; charset=utf-8
    // Content-Length: 229
    // 
    // <order>
    //   <customerName>John &amp; Sons</customerName>
    //   <note>He said &quot;Ship it ASAP!&quot;</note>
    //   <address>123 &lt;Main&gt; Street</address>
    //   <instructions>Use door #2 &amp; call upon arrival</instructions>
    // </order>

}