Swift

curl with Variable Substitution in a GraphQL Request Body

See more CURL Examples

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

func chilkatTest() {
    var success: Bool = false

    success = false

    // Variable names are enclosed between {{ and }}
    // Important: Variables should be placed inside the quotes.

    // curl -X POST https://api.example.com/graphql \
    //   -H "Content-Type: application/graphql; charset=utf-8" \
    //   -H "Accept: application/json" \
    //   --data-binary "mutation {
    //   createUser(
    //     input: {
    //       name: \"{{name}}\"
    //       city: \"{{city}}\"
    //       note: \"{{note}}\"
    //       bio: \"{{bio}}\"
    //     }
    //   ) {
    //     id
    //     name
    //   }
    // }"

    // Build the above curl command.
    let sbCurl = CkoStringBuilder()!
    sbCurl.appendLn(str: "curl -X POST https://api.example.com/graphql \\")
    sbCurl.appendLn(str: "  -H \"Content-Type: application/graphql; charset=utf-8\" \\")
    sbCurl.appendLn(str: "  -H \"Accept: application/json\" \\")
    sbCurl.appendLn(str: "  -d \"mutation {")
    sbCurl.appendLn(str: "  createUser(")
    sbCurl.appendLn(str: "    input: {")
    sbCurl.appendLn(str: "      name: \\\"{{name}}\\\"")
    sbCurl.appendLn(str: "      city: \\\"{{city}}\\\"")
    sbCurl.appendLn(str: "      note: \\\"{{note}}\\\"")
    sbCurl.appendLn(str: "      bio: \\\"{{bio}}\\\"")
    sbCurl.appendLn(str: "    }")
    sbCurl.appendLn(str: "  ) {")
    sbCurl.appendLn(str: "    id")
    sbCurl.appendLn(str: "    name")
    sbCurl.appendLn(str: "  }")
    sbCurl.appendLn(str: "}\"")

    let curl = CkoHttpCurl()!

    // Provide values for variables
    curl.setVar(varName: "name", varValue: "José O'Connor")
    curl.setVar(varName: "city", varValue: "München")
    curl.setVar(varName: "note", varValue: "He said \"Hello, world!\" — and left…")
    curl.setVar(varName: "bio", varValue: "Loves sushi, café visits, and π ≈ 3.14159")

    // 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 quote chars around "Hello, world!" are properly escaped.

    // POST /graphql HTTP/1.1
    // Accept: application/json
    // Host: api.example.com
    // Content-Type: application/graphql; charset=utf-8
    // Content-Length: 250
    // 
    // mutation {
    //   createUser(
    //     input: {
    //       name: "José O'Connor"
    //       city: "München"
    //       note: "He said \"Hello, world!\" — and left…"
    //       bio: "Loves sushi, café visits, and π ≈ 3.14159"
    //     }
    //   ) {
    //     id
    //     name
    //   }
    // }

}