Examples¶
The following examples provide a sampling of the various types of requests Lama2 handles presently. Execute each file as:
l2 <file_name>.l2
You can also clone the repo and open it up in VSCode, install the Lama2 extension and fire requests from there.
GET request¶
GET
https://httpbin.org/get
JSON POST request¶
One can dump the JSON body at the end of an .l2 file to create a POST request:
POST
https://httpbin.org/post
{
"a": "b",
"c": "d"
}
JSON POST in VarJSON format¶
Make a POST request with JSON body specified
as key=value. Lama2 converts the input into
a corresponding JSON value {"a": "b", "c": "d"}. We call the key=value format VarJSON. This example produces an effect identical to the previous one
POST
https://httpbin.org/post
a=b
c=d
Comments¶
One can start a comment anywhere in the file
with the # character.
# Pound symbol signifies a comment
POST
https://httpbin.org/post
a=b # Comments may start at the end of lines as well
c=d
# Comments work even after the payload
Environment Variables: Switch base URL¶
Specify variables in l2.env and then load
them up in the API files. Presently, the l2.env file should reside in the same directory as the .l2 API file.
l2.env
export LOCAL="http://localhost:8000"
export REMOTE="http://httpbin.org"
env_example.l2
POST
${REMOTE}/post
{
"lorem": "ipsum"
}
Get Source Files
Headers¶
Use key:value format to specify headers.
Specify strings for key/value in three ways:
- Double quoted (
"hello") - Single quoted (
'hello') - Unquoted (
hello)
POST
https://httpbin.org/post
# HEADERS
X-Parse-Application-Id:'helloworld'
X-Parse-REST-API-Key:"byeworld"
# DATA
a="b" # double-quoted string
'c'=d # single-quoted & unquoted strings
Get Source File
Note
The data section may appear before headers as well (see below)
POST
https://httpbin.org/post
# DATA
a="b" # double-quoted string
'c'=d # single-quoted & unquoted strings
# HEADERS
X-Parse-Application-Id:'helloworld'
X-Parse-REST-API-Key:"byeworld"
Send cookies in header¶
Headers represent cookies in Lama2. Just specify cookie key value pairs separated by
= within the header value as shown.
POST
https://httpbin.org/post
# HEADERS
Cookie:"sessionid=foo;another-cookie=bar"
# DATA
hello=world
Fill forms & attach files with MULTIPART¶
Use the MULTIPART keyword after the HTTP
verb to enable forms and file attachments.
The data section may contain any number of
form inputs using the key=value syntax.
Following the data section, one can specify
any number of files in the form of <field_name>@<file_path>. The file path is
relative to the API file.
POST
MULTIPART
http://httpbin.org/post
'X-Parse-Application-Id':hello
X-Parse-REST-API-Key:"world"
# DATA
first=second
# FILES
myfile@./image.jpeg
Image as Base64 encoded JSON field¶
We can embed images (or other files) as base64 strings in JSON using Lama2.
First, we define a PHOTO variable, loaded
up with the results of the base64 command.
l2.env
export PHOTO=`base64 -w 0 image.jpeg`
Next, we refer to the PHOTO variable in
the API file. Pay special attention to the
quoting mechanism "'{PHOTO}'".
Warning
The quoting must look exactly as shown in the following template for the request to work correctly.
base64_embed.l2
POST
http://httpbin.org/post
{
"imageb64_field": "'${PHOTO}'",
}
Chain requests using Javascript¶
In Lama2, we have alternating requestor and processor (JS) blocks, separated by ---.
Each processor (JS) block has a special variable result, storing the response
from previous requestor block. If possible,
result is automatically stored as a JS
object through JSON.parse(). Otherwise,
result is stored as a regular string.
url = "http://google.com"
REMOTE_COORD = "https://httpbing.org"
---
# stage 1
POST
${REMOTE_COORD}/anything
{
"username": "admin",
"password": "Password@123",
"from": "${LOCAL_COORD}/anything",
"url": "${url}",
"Token": "MySuperSecretToken"
}
---
// filtering, store in var
console.log("@@Result", result)
let TOKEN = result["json"]["Token"]
console.log(TOKEN)
---
# stage 2
GET
${REMOTE_COORD}/bearer
Authorization: 'Bearer ${TOKEN}'
{}
Get Source Files