Skip to content

Commit eaae20d

Browse files
committed
Update introduction
1 parent 2c8a7ea commit eaae20d

1 file changed

Lines changed: 32 additions & 28 deletions

File tree

docs/intro.md

Lines changed: 32 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -5,44 +5,48 @@ slug: /
55

66
# Intro
77

8-
Let's discover **Docusaurus in less than 5 minutes**.
8+
API tests management is not easy to develop, and maintain. It requires multitude of knowledge of programming libraries, business scenarios, infrastructure details, etc - unless you use ***chkware***.
99

10-
## Getting Started
10+
***chkware*** (pronounced as */check:ware/*) helps you write accurate, robust, and expressive feature tests for your API in less time.
1111

12-
Get started by **creating a new site**.
12+
## What it is
1313

14-
Or **try Docusaurus immediately** with **[docusaurus.new](https://docusaurus.new)**.
14+
**Chkware** is an API testing tool, a scriptable HTTP client, and a test specification management tool for the API era.
1515

16-
### What you'll need
16+
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:
1717

18-
- [Node.js](https://nodejs.org/en/download/) version 14 or above:
19-
- When installing Node.js, you are recommended to check all checkboxes related to dependencies.
18+
- Create reusable offline http request specification. [pre-released]
19+
- Create reusable test specifications. [TBD]
20+
- Create reusable test flows. [TBD]
21+
- Create reusable variable files to manage global and scoped data. [TBD]
2022

21-
## Generate a new site
23+
Afterward, you run those test specification files with **chkware**, and get test results or even reuse them.
2224

23-
Generate a new Docusaurus site using the **classic template**.
25+
## Motivation
2426

25-
The classic template will automatically be added to your project after you run the command:
27+
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.
28+
29+
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.
2630

27-
```bash
28-
npm init docusaurus@latest my-website classic
29-
```
31+
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.
3032

31-
You can type this command into Command Prompt, Powershell, Terminal, or any other integrated terminal of your code editor.
33+
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:
34+
1) specific programming language knowledge, so it is not easy to jump-in quick
35+
2) added complexity of maintaining supporting software stack, so there are side-effects
36+
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.
37+
38+
So, clearly enough I think this situation needs to be improved. This is the motivation for **Chkware**.
3239

33-
The command also installs all necessary dependencies you need to run Docusaurus.
40+
## Audiences
3441

35-
## Start your site
42+
The focused users of chkware are everyone involved in an API project, given they have some testing basics.
43+
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.
46+
- We need a tool that is very easy to learn, and fun to use.
47+
48+
In practical cases, software testers / QAs, developers, PM/POs, are the people who should be able to use it rigorously.
3649

37-
Run the development server:
38-
39-
```bash
40-
cd my-website
41-
npm run start
42-
```
43-
44-
The `cd` command changes the directory you're working with. In order to work with your newly created Docusaurus site, you'll need to navigate the terminal there.
45-
46-
The `npm run start` command builds your website locally and serves it through a development server, ready for you to view at http://localhost:3000/.
47-
48-
Open `docs/intro.md` (this page) and edit some lines: the site **reloads automatically** and displays your changes.
50+
- This project is particularly helpful if you are developing an API oriented project.
51+
- Test websites or web interfaces are not in the project focus for now.
52+
- Also, seeding data, validating data in DB is out of this project scope for now.

0 commit comments

Comments
 (0)