Categorygithub.com/apitoolkit/apitoolkit-go
modulepackage
2.0.1+incompatible
Repository: https://github.com/apitoolkit/apitoolkit-go.git
Documentation: pkg.go.dev

# README

APItoolkit's Logo APItoolkit's Logo

Golang SDK

APItoolkit SDK Join Discord Server APItoolkit Docs GoDoc

APItoolkit is an end-to-end API and web services management toolkit for engineers and customer support teams. To integrate your Golang 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:

go get github.com/apitoolkit/apitoolkit-go

Then add github.com/apitoolkit/apitoolkit-go to the list of dependencies like so:

package main

import (
  apitoolkit "github.com/apitoolkit/apitoolkit-go"
)

Configuration

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

package main

import (
  "context"
  "log"
  "net/http"
  apitoolkit "github.com/apitoolkit/apitoolkit-go"
)

func main() {
  ctx := context.Background()

  // Initialize the client
  apitoolkitClient, err := apitoolkit.NewClient(ctx, apitoolkit.Config{APIKey: "{ENTER_YOUR_API_KEY_HERE}"})
  if err != nil {
    panic(err)
  }

  // Register APItoolkit's middleware
  http.Handle("/", apitoolkitClient.Middleware(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
    w.WriteHeader(http.StatusOK)
    w.Write([]byte("Hello, World!"))
  })))

  http.ListenAndServe(":8080", nil)
}

[!NOTE]

  • This SDK supports multiple Golang frameworks (including, Chi, Echo, Fiber, Gin, Gorilla Mux, and Native). You can learn how to configure each framework using the provided Middleware (e.g., EchoMiddleware) in the respective linked docs above.
  • 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.


# Packages

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Functions

No description provided by the author
No description provided by the author
NewClient would initialize an APIToolkit client which we can use to push data to apitoolkit.
No description provided by the author
No description provided by the author
ReportError Allows you to report an error from your server to APIToolkit.
WithHTTPClient allows you supply your own custom http client.
No description provided by the author
No description provided by the author
No description provided by the author

# Constants

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Variables

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Structs

ATError is the Apitoolkit error type/object.
No description provided by the author
No description provided by the author
No description provided by the author
Payload represents request and response details FIXME: How would we handle errors from background processes (Not web requests).

# Type aliases

No description provided by the author