API testing with real-time reporting. CLI tool for api-testing
npm install prasad-api-testThe command-line interface (CLI) tool for testing APIs. It allows you to send HTTP requests (GET, POST, PUT, DELETE) to specified URLs and view the response data, status code, and response time.
You can install the package globally using npm:
``bash`
npm i -g prasad-api-test
OR Project Specific Folder
``
npm i rasad-api-test
prasad-api-test -u
- -u, --url: Specifies the URL of the API endpoint.-m, --method
- : Specifies the HTTP method (GET, POST, PUT, DELETE).-d, --data
- : Optional. Specifies the data to be sent with the request (for POST or PUT requests).
`bash
npx prasad-api-test -u https://jsonplaceholder.typicode.com/posts/1 -m GET
npx prasad-api-test -u https://jsonplaceholder.typicode.com/posts -m POST -d '{"title": "foo", "body": "bar", "userId": 1}'
npx prasad-api-test -u https://jsonplaceholder.typicode.com/posts/1 -m PUT -d '{"title": "bar", "body": "foo", "userId": 1}'
npx prasad-api-test -u https://jsonplaceholder.typicode.com/posts/1 -m DELETE
`
bash
Response Data: {
userId: 1,
id: 1,
title: 'sunt aut facere repellat provident occaecati excepturi optio reprehenderit',
body: 'quia et suscipit\n' +
'suscipit recusandae consequuntur expedita et cum\n' +
'reprehenderit molestiae ut ut quas totam\n' +
'nostrum rerum est autem sunt rem eveniet architecto'
}
Status Code: 200
Response Time: 295ms
`
Usage In The Code
`bash const { exec } = require('child_process');
// Function to execute the prasad-api-test CLI tool
function testAPI(url, method, data) {
const command =
npx prasad-api-test -u "${url}" -m ${method} ${data ? -d '${JSON.stringify(data)}' : ''};
exec(command, (error, stdout, stderr) => {
if (error) {
console.error(Error: ${error.message});
return;
}
if (stderr) {
console.error(Error: ${stderr});
return;
}
console.log(stdout);
});
}
// Example usage
const apiUrl = 'https://jsonplaceholder.typicode.com/posts';
const method = 'POST';
const requestData = {
title: 'mytitle',
body: 'data',
userId: 1
};
testAPI(apiUrl, method, requestData);``Contributions are welcome! If you find any bugs or want to add new features, feel free to open an issue or submit a pull request.
This project is licensed under the ISC License.