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/introduction.md
+13-12Lines changed: 13 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,16 +1,17 @@
1
1
---
2
2
slug: /
3
+
sidebar_position: 1
3
4
title: Introduction
4
5
hide_title: true
5
6
---
6
7
7
-
8
+
8
9
9
-
**Chkware** is an API testing tool, a scriptable HTTP client, and a test specification management tool for the API era.
10
+
**chkware** (pronounced as */check:ware/*) is an API testing tool, a scriptable HTTP client, and a test specification management tool for the API era.
10
11
11
12
It is available as a command-line application. You write test specification files in a [YAML](https://yaml.org/)-based [DSL](https://en.wikipedia.org/wiki/Domain-specific_language). In that specification file you will define some structured configurations to be used for the following purpose:
- Create reusable variable files to manage global and scoped data. [TBD]
@@ -21,28 +22,28 @@ Afterward, you run those test specification files with **chkware**, and get test
21
22
22
23
### Motivation
23
24
24
-
In today's world, API is one of the key fuels that drive business. It is the way web applications consume services from self-hosted or 3rd-party vendors. Recent technology movements are going to a fluid internet direction, where _vendor_A_ have one API, _vendor_B_ is another API provider, while we are the consumers (e-commerce, fin-tech) of those vendor APIs. We use those APIs to host our contents based on those APIs. Maybe we are _vendor_U_ hosting more complex APIs on top of those. So, with the upcoming complexity of integration we need better tooling for API testing. Testing tools for modularize api testing.
25
+
In today's world, API is one of the key fuels that drive business. It is the way web applications consume services from self-hosted or 3rd-party vendors. Recent technology movements are going to a fluid internet direction, where *vendor_A* have one API, *vendor_B* is another API provider, while we are the consumers (e-commerce, fin-tech) of those vendor APIs. We use those APIs to host our contents based on those APIs. Maybe we are *vendor_U* hosting more complex APIs on top of those. So, with the upcoming complexity of integration we need better tooling for API testing. Testing tools for modularize api testing.
25
26
26
27
API automation is playing a key role in this era. The benefits of API automation are clearly visible. There are plenty of tools to support all kinds of test automation. However, the complexity to create and maintain automated test cases using available tools is inescapable. No way it's quick to get started, or pick up without further education on the corresponding tools ecosystem. Furthermore, knowledge of the programming language that was used to develop the tools is also needed for advanced customization of test cases.
27
28
28
-
API testing tools are costly as well, in-term of licensing, setup and maintenance. Some of the tools you are available for free for simple use-cases, have complex licensing for increased usage, most of the time that aren't worth user usage. Also, commercial applications have limited community support, and knowledge exchange medium. Above that, of course, there are less and less open-source tools to cover these scenarios.
29
+
API testing tools are costly as well, in-term of licensing, setup and maintenance. Some tools are available for free for simple use-cases, but have complex licensing for increased usage, most of the time that aren't worthwhile. Also, commercial applications have limited community support, and knowledge exchange medium. Above that, of course, there are less and less open-source tools to cover these scenarios.
29
30
30
-
For these reasons, the solutions are less scaling for actual use-cases. With additional business knowledge (that is ever growing) required to start and maintain tests, you also need:
31
+
For these reasons, the solutions are less scaling for actual use-cases. With additional business knowledge (that is evergrowing) required to start and maintain tests, you also need:
31
32
32
-
1.specific programming language knowledge, so it is not easy to jump-in quick
33
-
2.added complexity of maintaining supporting software stack, so there are side-effects
33
+
1.Specific programming language knowledge, so it is not easy to jump-in quick
34
+
2.Added complexity of maintaining supporting software stack, so there are sideeffects
34
35
3. Above all, maintaining test cases based on code is more complex if you don't design your test code architecture well in the early days.
35
36
36
-
So, clearly enough I think this situation needs to be improved. This is the motivation for **Chkware**.
37
+
So, clearly enough I think this situation needs to be improved. This is the motivation for **chkware**.
37
38
38
39
---
39
40
40
41
### Audiences
41
42
42
-
The focused users of chkware are everyone involved in an API project, given they have some testing basics.
43
+
The focused users of **chkware** are everyone involved in an API project, given they have some testing basics.
43
44
44
-
- People with zero programming knowledge need a tool that does not get in their way.
45
-
- We need a tool that is relatively easy to write specifications, expressive, and customizable to the very core.
45
+
- People with zero programming knowledge need a tool that does not get in their way.
46
+
- We need a tool that is relatively easy to write specifications, expressive, and customizable to the very core.
46
47
- We need a tool that is very easy to learn, and fun to use.
47
48
48
49
In practical cases, software testers / QAs, developers, PM/POs, are the people who should be able to use it rigorously.
Copy file name to clipboardExpand all lines: docs/more-examples.md
+2-1Lines changed: 2 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,4 +1,5 @@
1
1
---
2
+
sidebar_position: 4
2
3
title: More Examples
3
4
hide_title: true
4
5
---
@@ -120,7 +121,7 @@ request:
120
121
121
122
### Examples
122
123
123
-
Following are the examples with HTTP GET method. Although all these example are still valied for POST, PUT, PATCH, DELETE, OPTIONS, HEAD method as well.
124
+
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.
0 commit comments