Skip to main content

No project description provided

Project description

APItoolkit's Logo APItoolkit's Logo

FastAPI SDK

APItoolkit SDK PyPI - Version PyPI - Downloads Join Discord Server APItoolkit Docs

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

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:

License

This repository is published under the MIT license.


Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

apitoolkit_fastapi-1.2.1.tar.gz (6.4 kB view details)

Uploaded Source

Built Distribution

apitoolkit_fastapi-1.2.1-py3-none-any.whl (7.1 kB view details)

Uploaded Python 3

File details

Details for the file apitoolkit_fastapi-1.2.1.tar.gz.

File metadata

  • Download URL: apitoolkit_fastapi-1.2.1.tar.gz
  • Upload date:
  • Size: 6.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.9.19

File hashes

Hashes for apitoolkit_fastapi-1.2.1.tar.gz
Algorithm Hash digest
SHA256 1fb1a55fca1bca2822fdb886166130c6ed5988ce055f1be909911e75a8492484
MD5 0d86a985f62b48ac078bbd83186a1abb
BLAKE2b-256 46fd3187153236095b91fd307f468e13230f6dde29fc28ff221dd9402cc26045

See more details on using hashes here.

File details

Details for the file apitoolkit_fastapi-1.2.1-py3-none-any.whl.

File metadata

File hashes

Hashes for apitoolkit_fastapi-1.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 443642d46be31bf57cd4185a79edabbca0517f85c0ff6b22af69f2a97e712406
MD5 aaa111aceedc2110e7e9e74703eb1b8f
BLAKE2b-256 c27434d4baf33e3aaa951a89ff3baa4781dbcfbf096b86a722c3a7869522eab0

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page