You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/05-References/051-http-reference.md
+6-27Lines changed: 6 additions & 27 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,35 +1,13 @@
1
1
---
2
-
title: Http spec. reference
2
+
title: Http specification reference
3
3
---
4
4
5
5
:::note
6
-
7
6
- This page should be use as reference for specification files.
8
7
- This page is subject to change. It is requested to check this page frequently.
9
-
10
8
:::
11
9
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.
33
11
34
12
```yaml
35
13
---
@@ -53,8 +31,8 @@ request:
53
31
'Accept-Encoding': 'gzip, deflate'
54
32
accept: '*/*'
55
33
56
-
# send authentication header.
57
-
# two supported type: auth[bearer], auth[basic]:
34
+
#==== send authentication header ====
35
+
# two supported type: auth[bearer], auth[basic]
58
36
59
37
# auth[bearer] example
60
38
auth[bearer]:
@@ -65,7 +43,8 @@ request:
65
43
username: Some_USER
66
44
password: 'Some-P@$$W03D'
67
45
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]
69
48
70
49
# to send application/x-www-form-urlencoded form enctype
0 commit comments