api-testing-tool is a testing tool which help you auto test all api with your testcase. You can use hudson... to schedule test it
Features:
- Create testcase with json config
- Inject variable in testcase to re-use in api (global, response variable...)
- Inject api template to re-use in testcase
- Support debug, validate, re-call api to ensure that your api services are fine
- Support upload multiple files
- Calculate execution time to run for each other and all
- Support to export to html document which is APIs specific document
- Support smart declare document to re-use, less step when you change or update document. Can update customize type in doc by add <> at the first line in content
- Update write log version which you updated on new document
- GUI is beautiful, easy to use
- You can write and inject your module to check or do something else
- You can temporary disabled some api without remove it in testcase
- In case, your data need a time to sync before call the next api, we support it too
- Can pick browser to open when test
api-testing-tool is testing tool which use javascript is base. So you can write testcase, customize by javascript
Api-testing-tool requires Node.js v4+ to run.
Download and extract the latest pre-built release.
Install the dependencies and devDependencies and start the server.
$ cd api-testing
$ npm installopen testing server which help response our request
$ npm startplay testcase demo
$ npm test demoCreate new project to use in your project
$ npm run gen "PROJECT NAME"- Write Testcase
- Run test or debug testcase
- After test ok, export to HTML doc
- 1.0.4 : Replace checker size to { equals: Length(?, ?) }
- 1.0.3 : Integrated instanceof into equals. Add more function in utils.now, utils.hash..., _ignoreUndefined
- 1.0.2 : Add check data type function. You can use
instanceofto validate data type. - 1.0.0 : Initial
utils.now(): Return date data
{ date : ${utils.now()} } // date field value is now, data type is Date
or
{ date: ${utils.now(1000*60*60*24)} } // date field value is now + 24 hours
or
{ date: ${utils.now(-1000*60*60*24)} } // date field value is now - 24 hours
or
{ date: ${utils.now(2015, 10, 11, 5, 6, 7)} } // date field value is Nov 11, 2015 5hours: 6min: 7sec. (hour, min, sec is optional)
utils.hash: encode, decode Base64, md5
{ password: utils.hash.md5('mypassword')} // return string md5 "34819d7beeabb9260a5c854bc85b3e44"
or
{ password: utils.hash.base64.encode('mypassword')} // return base64 encoding string "bXlwYXNzd29yZA=="
or
{ password: utils.hash.base64.decode('bXlwYXNzd29yZA==')} // return base64 decoding string "mypassword"
Check http response status must be in your expection
{ status : 200 }
or
{ status: [200, 201] }
Check response size (Array or string)
{ equals: Length(10) }
or
{ equals: Length(Any, 10) } // value must be <= 10
{ equals: Length(10, Any) } // value must be >= 10
{ equals: Length(1, 10) } // value must be >=1 and <= 10
{ equals: Length(Any, Any) } // value can be anything
Check array or object EQUALS another
{ equals: [
{id: 1, name: 'thanh', age: 20 },
{id: 2, name: 'bill', age: 22 },
]
}
or
{
equals: {
id: 1,
name: 'thanh',
age: 20
},
_apply: {
birthday: new Date(2016,1 ,1), // append field in equals object
age: Remove // Remove field age in object equals. This will help if you use variable in checker, you can manual append or remove some fields in it
},
_ignoreUndefined: true, // to ignore compare undefined value
}
Check array or object NOT EQUALS another
{ notEquals: [
{id: 1, name: 'thanh', age: 20 },
{id: 2, name: 'bill', age: 22 },
]
}
or
{ notEquals: {id: 1, name: 'thanh', age: 20 } }
Check array CONTAINS other object or array
{ contains: [
{id: 1, name: 'thanh', age: 20 },
{id: 2, name: 'bill', age: 22 },
]
}
or
{ contains: {id: 1, name: 'thanh', age: 20 } }
Check array is NOT CONTAINS other object or array
{ notContains: [
{id: 1, name: 'thanh', age: 20 },
{id: 2, name: 'bill', age: 22 },
]
}
or
{ notContains: {id: 1, name: 'thanh', age: 20 } }
Check array, object IN other array
{ in: [
{id: 1, name: 'thanh', age: 20 },
{id: 2, name: 'bill', age: 22 },
]
}
or
{ in: {id: 1, name: 'thanh', age: 20 } }
Check array, object NOT IN other array
{ notIn: [
{id: 1, name: 'thanh', age: 20 },
{id: 2, name: 'bill', age: 22 },
]
}
or
{ notIn: {id: 1, name: 'thanh', age: 20 } }
Check data type is INSTANCE OF the type
{ equals: String }
or
{ equals: /\d+/ }
or
{ equals: Dateable }
or
{ id: Number, name: Stringable, birthday: Dateable }
Data type:
String: Must be StringStringable: String or nullNumber: Must be NumberNumberable: Number or nullBoolean: Must be BooleanBooleanable: Boolean or nullArray: Must be ArrayArrayable: Array or nullObject: Must be ObjectObjectable: Object or nullDateable: Date or nullDate: Must be DateRegExp: Must be Regex expression which match stringRegExpable: Regex expression or nullLength(5): Check array or string length must be = 5Length(1, 4): Check array or string length must be >=1 and <=4Length(Any, 4): Check array or string length must be <= 4Length(4, Any): Check array or string length must be >=4Any: no check
api-testing-tool uses a number of open source projects to work properly:
- [AngularJS] - HTML enhanced for web apps!
- [Visual Studio Code] - code editor
- [node.js] - evented I/O for the backend
- [ExpressJS] - fast node.js network app framework
- [unirest] - Lightweight HTTP Request Client Libraries
- [open] - library which help open a file or url in the user's preferred application
- [copy-dir] - library which help copy template
- [async] - Async is a utility module
And of course api-testing-tool itself is open source with a https://github.com/just4developments/api-testing on GitHub.
MIT
Free Software, Hell Yeah!
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent