apitoolkit-fastapi 0.2.4

No project description provided

FastAPI SDK

APItoolkit is an end-to-end API and web services management toolkit for engineers and customer support teams. To integrate your FastAPI (Python) application with APItoolkit, you need to use this SDK to monitor incoming traffic, aggregate the requests, and then deliver them to the APItoolkit's servers.

---

Table of Contents

• Installation
• Configuration
• Contributing and Help
• License

---

Installation

Kindly run the command below to install the SDK:

pip install apitoolkit-fastapi

Configuration

Next, initialize APItoolkit in your application's entry point (e.g., main.py), like so:

from fastapi import FastAPI
from apitoolkit_fastapi import APIToolkit

app = FastAPI()

# Initialize APItoolkit
apitoolkit = APIToolkit(
    api_key = '{ENTER_YOUR_API_KEY_HERE}'
    debug = False
    tags = ["environment: production", "region: us-east-1"]
    service_version = "v2.0"
)
app.middleware('http')(apitoolkit.middleware)


@app.get("/")
def read_root():
    return {"Hello": "World"}

[!NOTE]

The {ENTER_YOUR_API_KEY_HERE} demo string should be replaced with the API key generated from the APItoolkit dashboard.

[!IMPORTANT]

To learn more configuration options (redacting fields, error reporting, outgoing requests, etc.), please read this SDK documentation.

Contributing and Help

To contribute to the development of this SDK or request help from the community and our team, kindly do any of the following:

• Read our Contributors Guide.
• Join our community Discord Server.
• Create a new issue in this repository.

License

This repository is published under the MIT license.

---