Skip to content

Commit 369685b

Browse files
committed
docs: improve readability for quick start
1 parent b361c30 commit 369685b

1 file changed

Lines changed: 21 additions & 15 deletions

File tree

docs/quick-start.md

Lines changed: 21 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -8,40 +8,46 @@ Prerequisite: [Setup **CHKware**](/docs/setup) to continue
88

99
:::
1010

11-
### A real business story
11+
### 1. A business story
1212

13-
DummyJSON service a JSON response faker for API. Let's think of a business case based on the [listed APIs](https://dummyjson.com/docs).
13+
DummyJSON service a JSON request / response faker for API. Let's think of a business case based on the [listed APIs](https://dummyjson.com/docs).
1414

15-
#### Business scenario:
15+
#### Business case:
1616

1717
User should be able to add a post on DummyJSON service.
1818

1919
#### Test cases:
2020

21-
Suppose our webapp have a page to add a new post. This page also shows some user information. Let's imagine the API test workflow for this page.
21+
Suppose our web application has a page to add a new post. This page also shows some user information.
22+
23+
Let's assume the API test workflow for this page looks like following:
2224

2325
1. User is able to login. API response have a bearer *access_token*.
2426
2. User is able to get *self* or *me* URL to show user information on page.
2527
3. User is able to create a post using that bearer *access_token*.
2628

27-
### Test implementation
29+
Let's create API test cases for these steps.
30+
31+
### 2. Test implementation
2832

2933
To implement the above test cases we need to be able to fetch an API response. Fetch multiple different APIs in a flow. Let's do in with *CHKware*.
3034

3135
#### Prepare for the project.
3236

33-
- Create a directory in anywhere in your system and give it a meaningful name.
34-
- Now open the console terminal where `chk` command is install. Follow setup steps if it hasn't been done already.
35-
- Go to the directory in console using
37+
- Create a directory called `my-api-project-tests` in anywhere in your system. You can give it any meaningful name.
38+
- Now open the console terminal. Please make sure `chk` command is installed globally. Follow [setup steps](./setup.md) if it hasn't been done already.
39+
- Go to the `my-api-project-tests` directory in console using
40+
3641
```shell
37-
cd [DIRECTORY]
42+
cd path/to/my-api-project-tests
3843
```
3944

4045
#### Login to get bearer *access_token*
4146

42-
- Create a file called `req-login.chk`. File name has no special significance. Open `req-login.chk` file, and add following:
47+
- Create a file called `req-login.chk`.
48+
- Open `req-login.chk` file in your favourite text editor, and add following:
4349

44-
```yaml
50+
```yaml title="path/to/my-api-project-tests/req-login.chk"
4551
---
4652
version: default:http:0.7.2
4753

@@ -61,7 +67,7 @@ expose:
6167
<details>
6268
<summary>Explanation</summary>
6369
64-
This file is called *HTTP specification* or *HTTP spec* file in *CHKware*. This file holds configuration to call an URL.
70+
This file is called *HTTP specification* or *HTTP spec* file in *CHKware*. This file holds configuration to make one HTTP request.
6571
6672
With `request:` node, we define what to request, and with `expose:` section we mention what to return. In this case the HTTP response body that was received.
6773

@@ -72,7 +78,7 @@ expose:
7278

7379
- Create a file called `req-user-me.chk`. File name has no special significance. Open `req-user-me.chk` file, and add following:
7480

75-
```yaml
81+
```yaml title="path/to/my-api-project-tests/req-user-me.chk"
7682
---
7783
version: default:http:0.7.2
7884
@@ -102,7 +108,7 @@ expose:
102108

103109
- Create a file called `req-post-create.chk`. File name has no special significance. Open `req-post-create.chk` file, and add following:
104110

105-
```yaml
111+
```yaml title="path/to/my-api-project-tests/req-post-create.chk"
106112
---
107113
version: default:http:0.7.2
108114
@@ -136,7 +142,7 @@ expose:
136142

137143
- Create a file called `wf-user-post-create.chk`. File name has no special significance. Open `wf-user-post-create.chk` file, and add following:
138144

139-
```yaml
145+
```yaml title="path/to/my-api-project-tests/wf-user-post-create.chk"
140146
---
141147
version: default:workflow:0.8.0
142148

0 commit comments

Comments
 (0)