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/04-more-examples.md
+11-25Lines changed: 11 additions & 25 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,26 +10,12 @@ hide_title: true
10
10
11
11
:::
12
12
13
-
This page describes some key concepts before you use **chkware**. There are two parts to this tool.
14
13
15
-
1. The command line tool that you can run as `chk`
16
-
2. The test specification files: those you write in YAML, in supported DSL.
17
-
18
-
### Test specifications
19
-
20
-
Test specification files are written in YAML. So, before you start writing any specs, you should have a proper introduction to YAML, if you do not have already. Here is a fine [YAML cheatsheet](https://quickref.me/yaml) to grasp some knowledge.
21
-
22
-
> In the future evolution path of **chkware** we are going to introduce more and more specification options and specification types and versions.
23
-
24
-
Let’s first get you introduced to the (till now) only specification format supported by **chkware**, the Http specification format. As mentioned in the introduction page **_Create reusable offline http request specification._**, the Http specification format is how you express a Http request format. Following are some examples by case to write Http specification file.
25
-
26
-
---
27
-
28
-
### Examples
14
+
## Examples
29
15
30
16
Following are the examples with HTTP GET method. Although all these example are still valid for POST, PUT, PATCH, DELETE, OPTIONS, HEAD method as well.
31
17
32
-
####Minimal request
18
+
### Minimal request
33
19
34
20
```yaml
35
21
---
@@ -38,7 +24,7 @@ request:
38
24
method: GET
39
25
```
40
26
41
-
#### Request with query string
27
+
### Request with query string
42
28
43
29
```yaml
44
30
---
@@ -61,7 +47,7 @@ request:
61
47
two: 2
62
48
```
63
49
64
-
#### Request with query string and header
50
+
### Request with query string and header
65
51
66
52
```yaml
67
53
---
@@ -78,7 +64,7 @@ request:
78
64
Accept-Encoding: gzip, deflate
79
65
```
80
66
81
-
#### Request with basic authentication header
67
+
### Request with basic authentication header
82
68
83
69
```yaml
84
70
---
@@ -97,7 +83,7 @@ request:
97
83
98
84
`username` and `password` will be automatically transformed to secret string as per [Basic Authentication](https://developer.mozilla.org/en-US/docs/Web/HTTP/Authentication#basic_authentication_scheme) scheme.
Copy file name to clipboardExpand all lines: docs/05-reference.md
+17-2Lines changed: 17 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,8 +10,23 @@ hide_title: true
10
10
11
11
:::
12
12
13
-
All `.chk` file is a valid YAML file. We are using this specific extension so these files do not make you
14
-
confuse in typical project layout.
13
+
This page describes some key concepts before you use **chkware**. There are two parts to this tool.
14
+
15
+
1. The command line tool that you can run as `chk http`
16
+
2. The test specification files: those you write in YAML, have extension `.chk`.
17
+
18
+
### Test specifications
19
+
20
+
Test specification files are written in YAML, having file extension `.chk`. So, before you start writing any
21
+
specs, you should have a proper introduction to YAML, if you do not have already. Here is a fine
22
+
[YAML cheatsheet](https://quickref.me/yaml) to grasp some knowledge.We are using this specific extension (`.chk`) so these files do not
23
+
make you confuse in typical project layout.
24
+
25
+
> In the future evolution path of **chkware** we are going to introduce more and more specification options and specification types and versions.
26
+
27
+
Let’s first get you introduced to the (till now) only specification format supported by **chkware**, the Http specification format. As mentioned in the introduction page **_Create reusable offline http request specification._**, the Http specification format is how you express a Http request format. Following are some examples by case to write Http specification file.
28
+
29
+
---
15
30
16
31
Following yaml blocks can be used to identify different section of a Http specification file.
0 commit comments