Lua Requires Chilkat v11.1.0+

Creating an application/json HTTP POST Request

See more HTTP Examples

Demonstrates how to create an HTTP POST request having the Content-Type application/json, where the body of the HTTP request is the following JSON:

{
   "username" : "my_username",
   "password" : "my_password",
   "validation-factors" : {
      "validationFactors" : [
         {
            "name" : "remote_address",
            "value" : "127.0.0.1"
         }
      ]
   }
}

The generated HTTP request looks like this:

POST /something HTTP/1.1
Content-Type: application/json
Accept: application/json
Host: domain
Content-Length: 216

{
  "username": "my_username",
  "password": "my_password",
  "validation-factors": {
    "validationFactors": [
      {
        "name": "remote_address",
        "value": "127.0.0.1"
      }
    ]
  }
}

Lua

local chilkat = require("chilkat")

-- This example demonstrates building an application/json request.

local req = chilkat.HttpRequest.new()

-- The ContentType, HttpVerb, and Path properties should
-- always be explicitly set.
req.http_verb = "POST"
req.path = "/something"
req.content_type = "application/json"

-- We may wish to add an "Accept" header to the request.
-- This tells the server we'll accept an application/json response.
req:add_header("Accept", "application/json")

-- We'll use Chilkat's JSON API to create the JSON body of the HTTP request.
local json = chilkat.JsonObject.new()
json:append_string("username", "my_username")
json:append_string("password", "my_password")

local vFactors = chilkat.JsonObject.new()
json:append_object2("validation-factors", vFactors)

local vArray = chilkat.JsonArray.new()
vFactors:append_array2("validationFactors", vArray)

local factorObj = chilkat.JsonObject.new()
vArray:add_object_at2(0, factorObj)
factorObj:append_string("name", "remote_address")
factorObj:append_string("value", "127.0.0.1")

-- Use the JSON for the HTTP request body
-- By default, the Emit method will output compact JSON.
-- This is best for generating the smallest size request.
-- To generate a more human-readable (pretty-printed) JSON request body,
-- set the EmitCompact property to FALSE
json.emit_compact = false
req:load_body_from_string(json:emit(), "utf-8")

-- View the request that would be sent if HttpSReq was called:
local requestMime = req:generate_request_text()
print(requestMime)

-- A few important comments about the HTTP request that is generated:
--
-- 1) The Content-Length header is automatically generated based on the actual length of the MIME message
--    that follows the intial (topmost) MIME header.
-- 2) The HOST header will automatically get filled in with the actual domain when HttpSReq
--    is called.