mirror of
https://github.com/Orange-OpenSource/hurl.git
synced 2024-11-26 00:22:10 +03:00
58 lines
1.6 KiB
Markdown
58 lines
1.6 KiB
Markdown
# Hurl File
|
||
|
||
## Character Encoding
|
||
|
||
Hurl file should be encoded in UTF-8, without a byte order mark at the beginning
|
||
(while Hurl ignores the presence of a byte order mark rather than treating it as an error)
|
||
|
||
## File Extension
|
||
|
||
Hurl file extension is `.hurl`
|
||
|
||
## Comments
|
||
|
||
Comments begin with `#` and continue until the end of line. Hurl file can serve as
|
||
a documentation for HTTP based workflows so it can be useful to be very descriptive.
|
||
|
||
```hurl
|
||
# A very simple Hurl file
|
||
# with tasty comments...
|
||
GET https://www.sample.net
|
||
x-app: MY_APP # Add a dummy header
|
||
|
||
HTTP 302 # Check that we have a redirection
|
||
[Asserts]
|
||
header "Location" exists
|
||
header "Location" contains "login" # Check that we are redirected to the login page
|
||
```
|
||
|
||
## Special Characters in Strings
|
||
|
||
String can include the following special characters:
|
||
|
||
- The escaped special characters \" (double quotation mark), \\ (backslash), \b (backspace), \f (form feed),
|
||
\n (line feed), \r (carriage return), and \t (horizontal tab)
|
||
- An arbitrary Unicode scalar value, written as \u{n}, where n is a 1–8 digit hexadecimal number
|
||
|
||
```hurl
|
||
GET https://example.org/api
|
||
|
||
HTTP 200
|
||
# The following assert are equivalent:
|
||
[Asserts]
|
||
jsonpath "$.slideshow.title" == "A beautiful ✈!"
|
||
jsonpath "$.slideshow.title" == "A beautiful \u{2708}!"
|
||
```
|
||
|
||
In some case, (in headers value, etc..), you will also need to escape # to distinguish it from a comment.
|
||
In the following example:
|
||
|
||
```hurl
|
||
GET https://example.org/api
|
||
x-token: BEEF \#STEACK # Some comment
|
||
HTTP 200
|
||
```
|
||
|
||
We're sending a header `x-token` with value `BEEF #STEACK`
|
||
|