Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/marcuwynu23/feyfetch
command-line automated testing tool for REST API routes, inspired by the enchanting realm of fey creatures
https://github.com/marcuwynu23/feyfetch
api cmd commandline curl http httpie python requests rest rest-api
Last synced: 2 days ago
JSON representation
command-line automated testing tool for REST API routes, inspired by the enchanting realm of fey creatures
- Host: GitHub
- URL: https://github.com/marcuwynu23/feyfetch
- Owner: marcuwynu23
- Created: 2024-04-02T06:57:53.000Z (6 months ago)
- Default Branch: main
- Last Pushed: 2024-04-04T11:28:16.000Z (6 months ago)
- Last Synced: 2024-09-21T01:33:45.964Z (6 days ago)
- Topics: api, cmd, commandline, curl, http, httpie, python, requests, rest, rest-api
- Language: Python
- Homepage:
- Size: 10.7 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# FeyFetch
[](https://github.com/marcuwynu23/feyfetch/blob/main/LICENSE)
[](https://github.com/marcuwynu23/feyfetch/stargazers)
[](https://github.com/marcuwynu23/feyfetch/issues)
FeyFetch is an automated testing tool crafted for efficient testing of REST API routes. It simplifies the process of testing API endpoints, ensuring reliability and performance with ease.
## Features
- **Automated Testing**: FeyFetch automates the testing of REST API routes, reducing manual effort and ensuring consistent testing procedures.
- **Configurable Headers**: Easily configure common headers to be included in all API requests for uniformity and ease of management.
- **Flexible Request Handling**: Support for various HTTP methods (GET, POST, PUT, DELETE, etc.) and optional request bodies allows for comprehensive testing of API endpoints.
- **Directory-Based Organization**: FeyFetch reads API requests from a specified directory, enabling easy organization and management of test cases.
- **Whimsical Charm**: With its playful name and mystical inspiration, FeyFetch adds a touch of whimsy to your testing endeavors.
## Installation
To install FeyFetch, simply clone this repository:
```bash
git clone https://github.com/marcuwynu23/feyfetch.git
```
## Usage
1. Create a `requests.json`or any name for your requests file in your `requests` directory with the following structure:
```json
{
"name": "Application API Requests",
"root": "http://localhost:9000/api",
"headers": {
"Content-Type": "application/json"
},
"routes": [
{
"path": "/auth/login",
"method": "GET"
},
{
"path": "/auth/login",
"method": "POST",
"body": {
"email": "[email protected]",
"password": "admin"
}
},
{
"path": "/auth/register",
"method": "POST",
"body": {
"email": "[email protected]",
"password": "admin",
"role": "admin"
}
},
{
"path": "/auth/recovery",
"method": "POST",
"body": {
"email": "[email protected]"
}
},
{
"path": "/auth/reset",
"method": "POST",
"body": {
"email": "[email protected]",
"password": "admin",
"token": "123"
}
},
{
"path": "/auth/logout",
"method": "GET"
},
{
"path": "/users",
"method": "GET"
}
]
}
```
2. Run FeyFetch by executing the main script and providing the path to the directory containing your requests configuration file:
```bash
fey
```
3. FeyFetch will automate the testing of your API routes based on the requests defined in request json file for example `requests.json` inside the requests folder, providing insights into the functionality and performance of your endpoints.
## Contributing
Contributions are welcome! Feel free to submit bug reports, feature requests, or pull requests to help improve FeyFetch and make it even more magical.
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.