Skip to content

Commit f735f97

Browse files
author
Serhat Bolsu
committed
readability for readme
1 parent 2833391 commit f735f97

File tree

1 file changed

+20
-14
lines changed

1 file changed

+20
-14
lines changed

README.md

Lines changed: 20 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
11
# API Testing Sample Framework with Javascript
22
Restful API testing sample framework. ATDD is the suggested design pattern with the help of resouce-objects.
33

4-
Jest is chosen since it is sharing the same `expect` library with webdriverio.
5-
It is much faster then mocha due to inherent parallelization.
4+
> Jest is chosen since it is sharing the same `expect` library with webdriverio.
5+
> It is much faster then mocha due to inherent parallelization.
6+
67

78
## Overview
89

@@ -14,19 +15,19 @@ You will find three suites that are representing different design choices
1415

1516
You can copy this library and use as you like, however think about the design choices you are changing.
1617

17-
Technology | Description
18-
---------- | -----------
19-
Acceptance Test Driven Development | ATDD involves team members with different perspectives (customer, development, testing) collaborating to write acceptance cases.
20-
Resource Objects | Design pattern like Page Object, represent each endpoint as resource
21-
Code as commit | Everything about test automation should be committed, including CI
18+
| Technology | Description |
19+
| ---------- | ----------- |
20+
| Acceptance Test Driven Development | ATDD involves team members with different perspectives (customer, development, testing) collaborating to write acceptance cases. |
21+
| Resource Objects | Design pattern like Page Object, represent each endpoint as resource |
22+
| Code as commit | Everything about test automation should be committed, including CI |
2223

23-
Tools | Description
24-
--- | ---
25-
superagent | Request is a library for making HTTP requests. This will be used for making the HTTP requests in the tests
26-
jest | Jest is a test executor that is running async. It includes assertion library.
27-
eslint | Static code analysis tool for Javascript
28-
husky | Regulate code commit (with linter in this case)
29-
express | Express is popular HTTP framework for NodeJS which will be used for creating the System Under Test.
24+
| Tools | Description |
25+
| --- | --- |
26+
| superagent | Request is a library for making HTTP requests. This will be used for making the HTTP requests in the tests |
27+
| jest | Jest is a test executor that is running async. It includes assertion library. |
28+
| eslint | Static code analysis tool for Javascript |
29+
| husky | Regulate code commit (with linter in this case) |
30+
| express | Express is popular HTTP framework for NodeJS which will be used for creating the System Under Test. |
3031

3132
## Setup
3233
First need to create your own configurations.
@@ -44,7 +45,9 @@ Run tests in local
4445

4546
```npm test```
4647

48+
4749
## Test Suites and Example usage
50+
4851
These are example usages of library. From 1 to 3 abstraction of endpoints increases.
4952

5053
#### 1- basic.spec.js
@@ -71,6 +74,7 @@ Uses resource object, this is a similar method used in selenium with **page Obje
7174
- usage of superagent/requests encapsulated, however still usable look at tc#3
7275
- Pre-initialized resource-objects, it serve as a facade to service under test.
7376

77+
7478
## Familiarizing Yourself with the System Under Test
7579

7680
It's always necessary to get to know the code you are testing.
@@ -105,6 +109,8 @@ The API supports adding and deleting individual vegetables. You can also get all
105109
* name
106110
* The name of the vegetable to delete
107111

112+
108113
## ToDO
114+
109115
- Allure reporting
110116
- Jenkinsfile

0 commit comments

Comments
 (0)