Lua
Lua
Add a Path Substitution Parameter to a REST Request
See more REST Examples
Demonstrates Rest.AddPathParam, which adds or replaces a path-substitution parameter. Before a request is sent, each occurrence of the name in the URI path is replaced with its value.
Background. Path parameters keep a URI path template readable—placeholders such as
{userId} are substituted with concrete values just before the request is sent.Chilkat Lua Downloads
local chilkat = require("chilkat")
local rest = chilkat.Rest.new()
-- Connect to the REST server. The 3rd argument enables TLS (use true for HTTPS on port 443),
-- and the 4th enables automatic reconnection if the connection is dropped between requests.
local bTls = true
local bAutoReconnect = true
local success = rest:connect("example.com", 443, bTls, bAutoReconnect)
if not success then
print(rest.last_error_text)
return
end
-- Add path-substitution parameters. Before a request is sent, each occurrence of the name in the
-- URI path is replaced with the value. This keeps the path template readable.
rest:add_path_param("{userId}", "12345")
rest:add_path_param("{orderId}", "98765")
-- The placeholders in the path are replaced before the request is sent.
local responseText = rest:full_request_no_body("GET", "/users/{userId}/orders/{orderId}")
if not rest.last_method_success then
print(rest.last_error_text)
return
end
print(responseText)