apiseek 0.3

A custom API dashboard for FastAPI endpoints.

APISEEK

APISEEK is a one-stop shop for every FastAPI request, providing essential metrics and insights for each API endpoint. It’s ideal for individuals and organizations looking to easily monitor API usage, performance, and user interactions.

Features

• Real-time Metrics: Track every FastAPI request as it happens.
• Comprehensive Dashboard: View data such as:
  • Request Name
  • Request Type (HTTP Method)
  • Total Requests (since server startup)
  • Successful Requests
  • Failed Requests
  • Average Response Time
  • Minimum Response Time
  • Median Response Time
  • Maximum Response Time
  • Most Recent Call (Timestamp & Response Time)

Installation and Setup

Prerequisites

• Python 3.7+
• FastAPI
• Uvicorn

Step 1: Prepare Your FastAPI Application

Ensure you have FastAPI and Uvicorn installed and your API endpoints are up and running. For example, you can install them via:

pip install fastapi uvicorn

Step 3: Integrate APISKEEK into Your Application

Install apiseek

pip install apiseek==0.2

Add the following code to your FastAPI application (e.g., in your main.py):

from fastapi import FastAPI
from apiseek import init_app

app = FastAPI()

# Initialize APISKEEK (dashboard will be available at /apiseek)
init_app(app)

# Define your API endpoints below
@app.get("/hello")
def hello():
    return {"message": "Hello, world!"}

Dashboard

Run your application using Uvicorn:

uvicorn main:app --reload

Then, open your browser and navigate to

http://127.0.0.1:8000/apiseek

or

localhost:8000/apiseek

You'll see the clean, intuitive dashboard displaying all the key metrics for your API endpoints.

Data Shown

Currently, the dashboard displays the following data for each API endpoint:

Request Name Request Type Total Requests (from server startup) Successful Requests Failed Requests Average Response Time Minimum Response Time Median Response Time Maximum Response Time Most Recent Call Response Time

How to Contribute

Contributions are welcome! If you have suggestions, improvements, or bug fixes, please reach out:

Email: [e-mail] LinkedIn: Programming Vikrant Let's discuss new features and improvements that can take APISKEEK from version 0.2 to 0.5 and beyond. Once we reach a larger user base, we'll set up proper community channels and governance to further develop this project.

License

APISEEK is released under the MIT License.