Dart 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"
      }
    ]
  }
}

Dart

import 'package:chilkat/chilkat.dart';

void main() {
  // This example demonstrates building an application/json request.

  final req = CkHttpRequest();

  // The ContentType, HttpVerb, and Path properties should
  // always be explicitly set.
  req.httpVerb = 'POST';
  req.path = '/something';
  req.contentType = '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.addHeader('Accept', 'application/json');

  // We'll use Chilkat's JSON API to create the JSON body of the HTTP request.
  final json = CkJsonObject();
  json.appendString('username', 'my_username');
  json.appendString('password', 'my_password');

  final vFactors = CkJsonObject();
  json.appendObject2('validation-factors', vFactors);

  final vArray = CkJsonArray();
  vFactors.appendArray2('validationFactors', vArray);

  final factorObj = CkJsonObject();
  vArray.addObjectAt2(0, factorObj);
  factorObj.appendString('name', 'remote_address');
  factorObj.appendString('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.emitCompact = false;
  req.loadBodyFromString(json.emit(), 'utf-8');

  // View the request that would be sent if HttpSReq was called:
  final requestMime = req.generateRequestText();
  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.
}