https://github.com/apitoolkit/apitoolkit-fastapi

APItoolkit's FastAPI (Python) client SDK.
https://github.com/apitoolkit/apitoolkit-fastapi

apitoolkit apitoolkit-sdk fastapi python

Last synced: 28 days ago
JSON representation

APItoolkit's FastAPI (Python) client SDK.

• Host: GitHub
• URL: https://github.com/apitoolkit/apitoolkit-fastapi
• Owner: apitoolkit
• License: mit
• Created: 2023-08-29T00:25:32.000Z (about 1 year ago)
• Default Branch: master
• Last Pushed: 2024-07-16T22:48:15.000Z (4 months ago)
• Last Synced: 2024-09-28T16:41:16.276Z (about 1 month ago)
• Topics: apitoolkit, apitoolkit-sdk, fastapi, python
• Language: Python
• Homepage: https://apitoolkit.io/docs/sdks/python/fastapi
• Size: 40 KB
• Stars: 2
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        


![APItoolkit's Logo](https://github.com/apitoolkit/.github/blob/main/images/logo-white.svg?raw=true#gh-dark-mode-only)

![APItoolkit's Logo](https://github.com/apitoolkit/.github/blob/main/images/logo-black.svg?raw=true#gh-light-mode-only)

## FastAPI SDK

[![APItoolkit SDK](https://img.shields.io/badge/APItoolkit-SDK-0068ff?logo=fastapi)](https://github.com/topics/apitoolkit-sdk) [![PyPI - Version](https://img.shields.io/pypi/v/apitoolkit-fastapi)](https://pypi.org/project/apitoolkit-fastapi) [![PyPI - Downloads](https://img.shields.io/pypi/dw/apitoolkit-fastapi)](https://pypi.org/project/apitoolkit-fastapi) [![Join Discord Server](https://img.shields.io/badge/Chat-Discord-7289da)](https://apitoolkit.io/discord?utm_campaign=devrel&utm_medium=github&utm_source=sdks_readme) [![APItoolkit Docs](https://img.shields.io/badge/Read-Docs-0068ff)](https://apitoolkit.io/docs/sdks/python/fastapi?utm_campaign=devrel&utm_medium=github&utm_source=sdks_readme) 

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](#installation)

- [Configuration](#configuration)

- [Contributing and Help](#contributing-and-help)

- [License](#license)

---

## Installation

Kindly run the command below to install the SDK:

```sh

pip install apitoolkit-fastapi

```

## Configuration

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

```python

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](https://apitoolkit.io/docs/dashboard/settings-pages/api-keys?utm_source=github-sdks) generated from the APItoolkit dashboard.




> [!IMPORTANT]

> 

> To learn more configuration options (redacting fields, error reporting, outgoing requests, etc.), please read this [SDK documentation](https://apitoolkit.io/docs/sdks/python/fastapi?utm_campaign=devrel&utm_medium=github&utm_source=sdks_readme).

## 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](https://github.com/apitoolkit/.github/blob/main/CONTRIBUTING.md).

- Join our community [Discord Server](https://apitoolkit.io/discord?utm_campaign=devrel&utm_medium=github&utm_source=sdks_readme).

- Create a [new issue](https://github.com/apitoolkit/apitoolkit-fastapi/issues/new/choose) in this repository.

## License

This repository is published under the [MIT](LICENSE) license.

---