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
+9-9Lines changed: 9 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,17 +4,17 @@ title: Introduction
4
4
5
5

6
6
7
-
**chkware** (pronounced as */check:ware/*) is an API testing tool, a scriptable HTTP client, and a test specification management tool for the API era.
7
+
8
+
*CHKware* (pronounced as */check:ware/*) is a low-code API testing tool, a script-able HTTP client, and an API test automation tool for the API era.
8
9
9
10
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:
Afterward, you run those test specification files with **chkware**, and get test results or even reuse them.
15
+
Afterward, you run those test specification files with *CHKware*, and get test results or even reuse them.
15
16
16
17
---
17
-
18
18
### Motivation
19
19
20
20
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.
@@ -29,13 +29,13 @@ For these reasons, the solutions are less scaling for actual use-cases. With add
29
29
2. Added complexity of maintaining supporting software stack, so there are side effects
30
30
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.
31
31
32
-
So, clearly enough I think this situation needs to be improved. This is the motivation for **chkware**.
32
+
So, clearly enough I think this situation needs to be improved. This is the motivation for *CHKware*.
33
33
34
34
---
35
35
36
36
### Audiences
37
37
38
-
The focused users of **chkware** are everyone involved in an API project, given they have some testing basics.
38
+
The focused users of **CHKware** are everyone involved in an API project, given they have some testing basics.
39
39
40
40
- People with zero programming knowledge need a tool that does not get in their way.
41
41
- We need a tool that is relatively easy to write specifications, expressive, and customizable to the very core.
@@ -44,7 +44,7 @@ The focused users of **chkware** are everyone involved in an API project, given
44
44
In practical cases, software testers / QAs, developers, PM/POs, are the people who should be able to use it rigorously.
45
45
46
46
- This project is particularly helpful if you are developing an API oriented project.
47
-
-Test websites or web interfaces are not in the project focus for now.
47
+
-Writing specification to test websites, or web interfaces are not in the project focus for now.
48
48
- Also, seeding data, validating data in DB is out of this project scope for now.
49
49
50
50
---
@@ -63,5 +63,5 @@ There is no native binary dependency, therefore it is expected on all the platfo
0 commit comments