Skip to content

Commit b016eb9

Browse files
committed
Rename Introduction.md to 1.-Introduction.md
1 parent 3e2ecae commit b016eb9

1 file changed

Lines changed: 22 additions & 24 deletions

File tree

Lines changed: 22 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,10 @@
11
---
2-
sidebar_position: 1
32
slug: /
3+
title: Introduction
4+
hide_title: true
45
---
56

6-
# Intro
7-
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***.
9-
10-
***chkware*** (pronounced as */check:ware/*) helps you write accurate, robust, and expressive feature tests for your API in less time.
11-
12-
## What it is
13-
14-
![Hero banner](./assets/github-hero-01.png)
7+
![Chkware | Test management for api era](./assets/github-hero-01.png)
158

169
**Chkware** is an API testing tool, a scriptable HTTP client, and a test specification management tool for the API era.
1710

@@ -24,29 +17,34 @@ It is available as a command-line application. You write test specification file
2417

2518
Afterward, you run those test specification files with **chkware**, and get test results or even reuse them.
2619

27-
## Motivation
20+
---
21+
22+
### Motivation
23+
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.
2825

29-
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.
30-
3126
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.
3227

33-
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.
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.
3429

3530
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:
36-
1) specific programming language knowledge, so it is not easy to jump-in quick
37-
2) added complexity of maintaining supporting software stack, so there are side-effects
38-
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.
39-
31+
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
34+
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+
4036
So, clearly enough I think this situation needs to be improved. This is the motivation for **Chkware**.
4137

42-
## Audiences
38+
---
39+
40+
### Audiences
41+
42+
The focused users of chkware are everyone involved in an API project, given they have some testing basics.
4343

44-
The focused users of chkware are everyone involved in an API project, given they have some testing basics.
45-
46-
- People with zero programming knowledge need a tool that does not get in their way.
47-
- We need a tool that is relatively easy to write specifications, expressive, and customizable to the very core.
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.
4846
- We need a tool that is very easy to learn, and fun to use.
49-
47+
5048
In practical cases, software testers / QAs, developers, PM/POs, are the people who should be able to use it rigorously.
5149

5250
- This project is particularly helpful if you are developing an API oriented project.

0 commit comments

Comments
 (0)