Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/apitoolkit/apitoolkit-dotnet
APIToolkit's .Net client SDK.
https://github.com/apitoolkit/apitoolkit-dotnet
apitoolkit apitoolkit-sdk dotnet
Last synced: about 17 hours ago
JSON representation
APIToolkit's .Net client SDK.
- Host: GitHub
- URL: https://github.com/apitoolkit/apitoolkit-dotnet
- Owner: apitoolkit
- License: mit
- Created: 2023-05-06T17:14:13.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-04-11T20:11:34.000Z (7 months ago)
- Last Synced: 2024-04-12T00:05:27.649Z (7 months ago)
- Topics: apitoolkit, apitoolkit-sdk, dotnet
- Language: C#
- Homepage:
- Size: 80.1 KB
- Stars: 3
- Watchers: 2
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## .NET Core SDK
[](https://github.com/topics/apitoolkit-sdk) [](https://apitoolkit.io/discord?utm_campaign=devrel&utm_medium=github&utm_source=sdks_readme) [](https://apitoolkit.io/docs/sdks/dotnet/dotnetcore?utm_campaign=devrel&utm_medium=github&utm_source=sdks_readme) [](https://github.com/apitoolkit/apitoolkit-dotnet1/actions?query=workflow%3ACI) [](https://nuget.org/packages/ApiToolkit.Net) [](https://nuget.org/packages/ApiToolkit.Net)
APItoolkit is an end-to-end API and web services management toolkit for engineers and customer support teams. To integrate .Net web services 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 package:
```sh
dotnet add package ApiToolkit.Net
```
## Configuration
Next, initialize APItoolkit in your application's entry point (e.g., `Program.cs`) like so:
```csharp
using ApiToolkit.Net;
// Initialize the APItoolkit client
var config = new Config
{
ApiKey = "{ENTER_YOUR_API_KEY_HERE}",
Debug = false,
Tags = new List { "environment: production", "region: us-east-1" },
ServiceVersion: "v2.0",
};
var client = await APIToolkit.NewClientAsync(config);
// END Initialize the APItoolkit client
# Register the middleware to use the initialized client
app.Use(async (context, next) =>
{
var apiToolkit = new APIToolkit(next, client);
await apiToolkit.InvokeAsync(context);
});
# app.UseEndpoint(..)
# other middleware and logic
# ...
```
> [!NOTE]
>
> - Please make sure the APItoolkit middleware is added before `UseEndpoint` and other middleware are initialized.
> - 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_campaign=devrel&utm_medium=github&utm_source=sdks_readme) 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/dotnet/dotnetcore?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-dotnet/issues/new/choose) in this repository.
## License
This repository is published under the [MIT](LICENSE) license.
---
