Zig Requires Chilkat v11.0.0+

Lower-Level REST API Methods (Google Cloud Storage)

See more REST Examples

The FullRequest* methods, such as FullRequestBinary, FullRequestMultipart, FullRequestNoBody, FullRequestStream, FullRequestString, etc. are high-level REST API methods that both send the request and receive the response. It is often the case that an application needs make a REST call, but with a finer level of control. The Chilkat REST API provides this feature. An application can break a REST call into the following parts:

1. Send the HTTP request. (via the SendReq* methods)
2. Receive the HTTP response header. (ReadResponseHeader)
3. Receive the HTTP response body. (via the ReadRespBody* methods)

This example demonstrates a REST call using SendReqStringBody, ReadResonseHeader, and ReadRespBodyString.

Zig

const std = @import("std");
const chilkat = @import("chilkat");

pub fn main(init: std.process.Init) !void {
    const alloc = init.arena.allocator();

    // This example demonstrates a REST call using SendReqStringBody, ReadResonseHeader, and ReadRespBodyString.
    // It will create a bucket in Google Cloud Storage.

    // It requires the Chilkat API to have been previously unlocked.
    // See Global Unlock Sample for sample code.

    const g_auth = try chilkat.AuthGoogle.init();
    defer g_auth.deinit();
    // Obtain an access token as shown in one of the following examples:
    // See Get Access Token using a Service Account JSON Key
    // See Get Access Token using a P12 File

    const rest = try chilkat.Rest.init();
    defer rest.deinit();

    // Connect using TLS.
    const b_auto_reconnect = true;
    try rest.connect("www.googleapis.com", 443, true, b_auto_reconnect);

    // Provide the authentication credentials (i.e. the access key)
    try rest.setAuthGoogle(g_auth);

    // Build the JSON request body for creating a bucket.
    // The only required property is the "name", but we'll add more
    // to make a better example..
    const json_req_body = try chilkat.JsonObject.init();
    defer json_req_body.deinit();
    try json_req_body.addStringAt(-1, "name", "chilkat-bucket-c");
    try json_req_body.addStringAt(-1, "kind", "storage#bucket");
    try json_req_body.addStringAt(-1, "location", "US");

    const obj_versioning = try chilkat.JsonObject.init();
    defer obj_versioning.deinit();
    json_req_body.appendObject2("versioning", obj_versioning) catch {};
    try obj_versioning.addBoolAt(-1, "enabled", true);

    // Show the HTTP request body we'll be sending.
    std.debug.print("{s}\n", .{try json_req_body.emit(alloc)});

    // Add the required query parameter.
    // See https://cloud.google.com/storage/docs/json_api/v1/buckets/insert
    try rest.addQueryParam("project", "chilkattest-1050");

    // Add the Content-Type HTTP request header.
    try rest.addHeader("Content-Type", "application/json; charset=UTF-8");

    // Send the REST HTTP request.
    rest.sendReqStringBody("POST", "/storage/v1/b", try json_req_body.emit(alloc)) catch {
        std.debug.print("{s}\n", .{try rest.getLastErrorText(alloc)});
        return;
    };

    // Read the response header.
    const response_status_code = rest.readResponseHeader();
    if (response_status_code < 0) {
        // We were unable to receive the response header.
        std.debug.print("{s}\n", .{try rest.getLastErrorText(alloc)});
        return;
    }

    if (response_status_code != 200) {
        // The response was not successful.  We'll still need to receive
        // the response body, which may contain an error message from the server.
        // If the response has no body, then the method for reading the
        // response body can still be called.  It will simply return with an empty
        // response body.

        // We can examine the response header and status text:
        std.debug.print("Response status text: {s}\n", .{try rest.getResponseStatusText(alloc)});
        std.debug.print("Response header: {s}\n", .{try rest.getResponseHeader(alloc)});
    }

    // Read the response body.  In this case we're expecting it to be JSON..
    const response_body_str = rest.readRespBodyString(alloc) catch {
        // We were unable to receive the response body.
        // Note: If the response did not include a body (such as for cases where
        // the Content-Length header is 0, or if the response status code implicitly
        // indicates no body, then ReadRespBodyString returns cktrue, and the
        // responseBodyString will be an empty string.
        std.debug.print("{s}\n", .{try rest.getLastErrorText(alloc)});
        return;
    };

    // Show the JSON response.
    std.debug.print("Json Response: {s}\n", .{response_body_str});
}