Skip to content

Commit 3355d1a

Browse files
committed
Http specification reference update
1 parent e647f10 commit 3355d1a

1 file changed

Lines changed: 6 additions & 27 deletions

File tree

docs/05-References/051-http-reference.md

Lines changed: 6 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,13 @@
11
---
2-
title: Http spec. reference
2+
title: Http specification reference
33
---
44

55
:::note
6-
76
- This page should be use as reference for specification files.
87
- This page is subject to change. It is requested to check this page frequently.
9-
108
:::
119

12-
This page describes some key concepts before you use **chkware**. There are two parts to this tool.
13-
14-
1. The command line tool that you can run as `chk http`
15-
2. The test specification files: those you write in YAML, have extension `.chk`.
16-
17-
### Specification files
18-
19-
Test specification files are written in YAML, having file extension `.chk`. So, before you start writing any
20-
specs, you should have a proper introduction to YAML, if you do not have already. Here is a fine
21-
[YAML cheatsheet](https://quickref.me/yaml) to grasp some knowledge. We are using this specific extension (`.chk`)
22-
so these files do not make you confuse in typical project layout.
23-
24-
> In the future evolution path of **chkware** we are going to introduce more and more specification
25-
> options and specification types and versions.
26-
27-
28-
### Http specification
29-
30-
Let’s get introduced to the Http specification format supported by **chkware**. The Http specification
31-
format is how anyone express a Http request. Following is the full reference to write
32-
Http specification file.
10+
Let’s get introduced to the Http specification format. The Http specification format is how anyone express a Http request. Following is the full reference to write Http specification file.
3311

3412
```yaml
3513
---
@@ -53,8 +31,8 @@ request:
5331
'Accept-Encoding': 'gzip, deflate'
5432
accept: '*/*'
5533

56-
# send authentication header.
57-
# two supported type: auth[bearer], auth[basic]:
34+
# ==== send authentication header ====
35+
# two supported type: auth[bearer], auth[basic]
5836

5937
# auth[bearer] example
6038
auth[bearer]:
@@ -65,7 +43,8 @@ request:
6543
username: Some_USER
6644
password: 'Some-P@$$W03D'
6745

68-
# send request body with the request
46+
# ==== send request body with the request ====
47+
# There are 5 supported type: body[form], body[form-data], body[json], body[xml], body[text]
6948

7049
# to send application/x-www-form-urlencoded form enctype
7150
body[form]:

0 commit comments

Comments
 (0)