Build Request

Some examples show how to build reuqest.

set headers
post form
post with body in file
set cookie
save a cookie then use it in another case
basic auth
send msgpack
use tempalte
chain the requests
config: set a timeout for case
config: set repeat for case
config: set retry for case

set headers

title: set header
description: set header
request:
  method: get
  url: 'http://httpbin.org/get'
  header:
    User-Agent: "test-client"

assert:
  status: ok
  statusCode: 200
  contentLength_gt: 180
  contentType: application/json

post form

title: http method post form
description: http method post form
request:
  method: post
  url: 'http://httpbin.org/post'
  body: 'param1=value1&param2=value2'
  header:
    Content-Type: application/x-www-form-urlencoded
assert:
  status: ok
  statusCode: 200
  contentLength_gt: 180
  contentType: application/json

post with body in file

normally, we can put the body in config file

title: http method post
description: http method post
request:
  method: post
  url: 'http://httpbin.org/post'
  body: |
    {
        "hello": "world"
    }
  header:
    Content-Type: application/json
assert:
  status: ok
  statusCode: 200
  contentLength_gt: 180
  contentType: application/json

or, we can post with a file by @

title: http method post with body file
description: http method post with body file
request:
  method: post
  url: 'http://httpbin.org/post'
  body: '@./post_body_file'
  header:
    Content-Type: application/json
assert:
  status: ok
  statusCode: 200
  contentLength_gt: 180
  contentType: application/json

title: http method set cookies
description: http method set cookies
request:
  method: get
  url: 'http://httpbin.org/cookies'
  cookie: uid=123
  header:
    Content-Type: application/json
assert:
  status: ok
  statusCode: 200
  contentLength_gt: 0
  contentType: application/json
  json:
    - path: cookies.uid
      value: '123'

use hook.save_cookie to save cookie into file

title: http method share cookies
description: http method share cookies
request:
  method: get
  url: 'http://httpbin.org/cookies/set?name1=value1&name2=value2'
  header:
    Content-Type: application/json
assert:
  status: ok
  statusCode: 200
  contentLength_gt: 0
  contentType: application/json
  json:
    - path: cookies.name1
      value: value1
hook:
  save_cookie: share_cookies.txt

then use it via @ in another case

title: http method share cookies
description: http method share cookies
request:
  method: get
  url: 'http://httpbin.org/cookies'
  cookie: '@share_cookies.txt'
  header:
    Content-Type: application/json
assert:
  status: ok
  statusCode: 200
  contentLength_gt: 0
  contentType: application/json
  json:
    - path: cookies.name1
      value: value1

basic auth

title: http method basic auth
description: http method basic auth
request:
  method: get
  url: 'http://httpbin.org/basic-auth/hello/world'
  header:
    Content-Type: application/json
    # equals to
    # Authorization: Basic aGVsbG86d29ybGQ=
  basic_auth:
    username: hello
    password: world
assert:
  status: ok
  statusCode: 200
  contentLength_gt: 0
  contentType: application/json
  json:
    - path: authenticated
      value: true
    - path: user
      value: hello

send msgpack

will auto encode the json with msgpack then send

title: http method post msgpack
description: http method post msgpack
request:
  method: post
  url: 'http://127.0.0.1:8080/anything'
  body: |
    {
        "hello": "world",
        "a": "1",
        "b": "2",
        "c": "1",
        "foo": "bar"
    }
  header:
    Content-Type: application/msgpack
assert:
  status: ok
  statusCode: 200
  contentLength_gt: 180
  contentType: application/json

use tempalte

you can create an config.yaml with a lot of envs (examples/config.yaml)

env:
  hello: world
  name: tom
  host: 'http://httpbin.org'
  content_type: application/json
  array:
    - a
    - b
    - c

then use go template in the case (examples/request_use_template.yaml)

title: http method post, use template
description: http method post use template
request:
  method: post
  url: '/post'
  body: |
    {
        "hello": "",
        "world": "in debug mode""not debug mode",
        "array": "  "
    }
  header:
    Content-Type: ''
assert:
  status: ok
  statusCode: 200
  contentLength_gt: 180
  contentType: ''

run with command

$ ./fetch run -c examples/config.yaml examples/request_use_template.yaml

# will send
DEBUG request:
> POST /post HTTP/1.1
> Host: httpbin.org
> User-Agent: fetch/1.0.0
> Content-Length: 83
> Content-Type: application/json
> Accept-Encoding: gzip
>
> {
>     "hello": "tom",
>     "world": "not debug mode",
>     "array": " 0a  1b  2c "
> }
>

also, you can add env in case, which’s priority is higher than env in config file(./fetch -c config.yaml) (examples/request_use_template_local.yaml)

title: 'http method post, use template local'
description: http method post, use template local
request:
  method: post
  url: '/post'
  body: |
    {
        "hello": "",
        "world": "in debug mode""not debug mode",
        "array": "  "
    }
  header:
    Content-Type: ''
env:
  name: jerry
assert:
  status: ok
  statusCode: 200
  contentLength_gt: 180
  contentType: ''

run with command

$ ./fetch run -c examples/config.yaml examples/request_use_template_local.yaml

# will send
DEBUG request:
> POST /post HTTP/1.1
> Host: httpbin.org
> User-Agent: fetch/1.0.0
> Content-Length: 85
> Content-Type: application/json
> Accept-Encoding: gzip
>
> {
>     "hello": "jerry",
>     "world": "not debug mode",
>     "array": " 0a  1b  2c "
> }
>

chain the requests

you can chain the requests, the response of the previous request will be parsed and saved in the context, then you can use it in the next request

```yaml
request:
  method: get
  url: 'https://httpbin.org/get'
assert:
  status: ok
  statusCode: 200
parse:
  - key: origin
    source: body
    jmespath: "origin"
  - key: length
    source: header
    header: Content-Length
---
request:
  method: get
  url: 'https://httpbin.org/get'
  header:
    X-GOT-ORIGIN: ''
assert:
  statusCode: 302

config: set a timeout for case

title: http timeout
description: http timeout
request:
  method: get
  url: 'http://httpbin.org/get'
config:
  timeout: 1
assert:
  status: ok
  statusCode: 200
  contentLength_gt: 10
  contentType: application/json

the priority of timeout in case is higher than timeout in config file(./fetch -c config.yaml)

config: set repeat for case

title: http method get repeat
description: http method get repeat
request:
  method: get
  url: 'http://httpbin.org/get'
config:
  repeat: 3
assert:
  status: ok
  statusCode: 200
  contentLength_gt: 10
  contentType: application/json

config: set retry for case

if statusCode not equals to 200, will retry for 3 times, and the interval is 1000ms

if equals to 200, will do assertions, or use the last response to do assertions.

title: http method get retry
description: http method get retry
request:
  method: get
  url: 'http://httpbin.org/status/500'
config:
  retry:
    enable: true
    count: 3
    interval: 1000
    statusCodes:
      - 200
assert:
  status: ok
  statusCode: 200
  contentLength_gt: 10
  contentType: application/json