Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/apitoolkit/apitoolkit-go
APItoolkit's Golang client SDK.
https://github.com/apitoolkit/apitoolkit-go
apitoolkit apitoolkit-sdk gin-gonic go-chi go-echo go-fiber go-mux golang gorilla-mux
Last synced: about 17 hours ago
JSON representation
APItoolkit's Golang client SDK.
- Host: GitHub
- URL: https://github.com/apitoolkit/apitoolkit-go
- Owner: apitoolkit
- License: mit
- Created: 2021-11-18T20:15:27.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2024-07-22T10:20:32.000Z (4 months ago)
- Last Synced: 2024-07-22T12:15:06.545Z (4 months ago)
- Topics: apitoolkit, apitoolkit-sdk, gin-gonic, go-chi, go-echo, go-fiber, go-mux, golang, gorilla-mux
- Language: Go
- Homepage: https://apitoolkit.io/docs/sdks/golang/
- Size: 406 KB
- Stars: 10
- Watchers: 4
- Forks: 7
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## Golang 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/golang?utm_campaign=devrel&utm_medium=github&utm_source=sdks_readme) [](https://godoc.org/github.com/apitoolkit/apitoolkit-go)
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](#installation)
- [Configuration](#configuration)
- [Contributing and Help](#contributing-and-help)
- [License](#license)
---
## Installation
Kindly run the command below to install the SDK:
```sh
go get github.com/apitoolkit/apitoolkit-go/gin
```
Then, add `github.com/apitoolkit/apitoolkit-go/gin` to the list of dependencies, like so:
```go
package main
import (
apitoolkit "github.com/apitoolkit/apitoolkit-go/gin"
)
```
## Configuration
Next, initialize APItoolkit in your application's entry point (e.g., `main.go`) like so:
```go
package main
import (
"context"
"log"
"net/http"
"github.com/gin-gonic/gin"
apitoolkit "github.com/apitoolkit/apitoolkit-go/gin"
)
func main() {
ctx := context.Background()
router := gin.New()
// Initialize the client
apitoolkitClient, err := apitoolkit.NewClient(ctx, apitoolkit.Config{APIKey: "{ENTER_YOUR_API_KEY_HERE}"})
if err != nil {
panic(err)
}
// Register APItoolkit's Gin middleware
router.Use(apitoolkit.GinMiddleware(apitoolkitClient))
router.GET("/", func(c *gin.Context) {
c.JSON(200, gin.H{
"message": "Hello World",
})
})
router.Run(":8080")
}
```
> [!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_campaign=devrel&utm_medium=github&utm_source=sdks_readme) generated from the APItoolkit dashboard.
> - This SDK supports other Golang web frameworks (including, [Chi](https://apitoolkit.io/docs/sdks/golang/chi?utm_campaign=devrel&utm_medium=github&utm_source=sdks_readme), [Echo](https://apitoolkit.io/docs/sdks/golang/echo?utm_campaign=devrel&utm_medium=github&utm_source=sdks_readme), [Fiber](https://apitoolkit.io/docs/sdks/golang/fiber?utm_campaign=devrel&utm_medium=github&utm_source=sdks_readme), [Gin](https://apitoolkit.io/docs/sdks/golang/gin?utm_campaign=devrel&utm_medium=github&utm_source=sdks_readme), [Gorilla Mux](https://apitoolkit.io/docs/sdks/golang/gorillamux?utm_campaign=devrel&utm_medium=github&utm_source=sdks_readme), and [Native](https://apitoolkit.io/docs/sdks/golang/native?utm_campaign=devrel&utm_medium=github&utm_source=sdks_readme)). You can learn how to configure each framework in their respective documentation (linked above).
> [!IMPORTANT]
>
> To learn more configuration options (redacting fields, error reporting, outgoing requests, etc.), please read this [SDK documentation](https://apitoolkit.io/docs/sdks/golang?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-go/issues/new/choose) in this repository.
## License
This repository is published under the [MIT](LICENSE) license.
---
