Skip to content

Paulander/ApiGuru

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

17 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

# API Guru

API Guru is a web-based API call management tool created with help from Replit.
It allows users to make, save, and manage API calls, as well as view call history and statistics.

## Features

- Make API calls (GET and POST methods supported)
- Save and load predefined API calls
- Verify API keys
- View API call history
- Dashboard with API usage statistics
- Export and import predefined calls

## Technologies Used

- Python 3.11
- Flask 3.0.3
- PostgreSQL (via psycopg2-binary 2.9.9)
- Requests 2.32.3
- Chart.js (for dashboard visualizations)

## Setup and Installation

1. Clone this repository to your local machine or Replit environment.
2. Ensure you have Python 3.11 installed.
3. Install the required dependencies:

pip install -r requirements.txt

Or if using Poetry:

poetry install

4. Set up your PostgreSQL database and update the environment variables with your database credentials:
- PGHOST
- PGPORT
- PGDATABASE
- PGUSER
- PGPASSWORD

## Running the Application

To run the application:

1. Ensure all dependencies are installed (see Setup and Installation section).
2. Make sure your PostgreSQL database is set up and running.
3. Set the necessary environment variables for database connection (PGHOST, PGPORT, PGDATABASE, PGUSER, PGPASSWORD).
4. Execute the following command in your terminal:


python main.py


The application will start and be accessible at `http://localhost:5000` or the URL provided by your Replit environment.


5. The application will start and be accessible at `http://localhost:5000`.

If you're using Replit:

1. The .replit file is already configured to run the application.
2. Simply click the "Run" button in the Replit interface.
3. The application will start and be accessible at the URL provided by Replit.

Note: The application is set to run on host '0.0.0.0' and port 5000 by default.
You can modify these settings in the `main.py` file if needed.



## Development

This project was developed with the help of Replit, an online IDE that makes it easy to write and deploy code.
The project structure and configuration files are set up to work seamlessly with Replit's environment.

## Contributing

Contributions to API Guru are welcome! Please feel free to submit a Pull Request.

About

Simple webapp to test REST API calls and get info. Supports saving call templates

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published