mirror of
https://github.com/Unleash/unleash.git
synced 2024-10-18 20:09:08 +02:00
2cd5028125
* refactor how-to guide for creating a token * fix token links * update SDK reference * beginning of direct api guide * refactored frontend api guide * lint staged breaking notes * update docs - cors for frontend * update token guide images * update after review * Apply suggestions from code review `website/docs/user_guide/token.mdx` Co-authored-by: Thomas Heartman <thomas@getunleash.ai> * Apply suggestions from code review `website/docs/topics/frontend-api.md` Co-authored-by: Thomas Heartman <thomas@getunleash.ai> * Apply suggestions from code review Co-authored-by: Thomas Heartman <thomas@getunleash.ai> * Apply suggestions from code review Co-authored-by: Thomas Heartman <thomas@getunleash.ai> * pr review * docs: Add info about front-end tokens + formatting * docs: add info about token anatomy * docs: link to correct place in doc * docs: replace "direct access API" -> "front-end API" * docs: rename file frontend-api -> front-end-api Co-authored-by: Thomas Heartman <thomas@getunleash.ai>
85 lines
2.4 KiB
Markdown
85 lines
2.4 KiB
Markdown
---
|
|
id: go_sdk
|
|
title: GO SDK
|
|
---
|
|
|
|
> You will need your `API URL` and your `API token` in order to connect the Client SDK to you Unleash instance. You can find this information in the “Admin” section Unleash management UI. [Read more](../user_guide/api-token)
|
|
|
|
### 1. Install unleash-client-go {#1-install-unleash-client-go}
|
|
|
|
To install the latest version of the client use:
|
|
|
|
```bash
|
|
go get github.com/Unleash/unleash-client-go/v3
|
|
```
|
|
|
|
If you are still using Unleash Server v2.x.x, then you should use:
|
|
|
|
```bash
|
|
go get github.com/Unleash/unleash-client-go
|
|
```
|
|
|
|
### 2. Initialize unleash {#2-initialize-unleash}
|
|
|
|
The easiest way to get started with Unleash is to initialize it early in your application code:
|
|
|
|
```go
|
|
import (
|
|
"github.com/Unleash/unleash-client-go/v3"
|
|
)
|
|
|
|
func init() {
|
|
unleash.Initialize(
|
|
unleash.WithListener(&unleash.DebugListener{}),
|
|
unleash.WithAppName("my-application"),
|
|
unleash.WithUrl("http://unleash.herokuapp.com/api/"),
|
|
unleash.WithCustomHeaders(http.Header{"Authorization": {"<API token>"}}),
|
|
)
|
|
}
|
|
```
|
|
|
|
### 3. Use unleash {#3-use-unleash}
|
|
|
|
After you have initialized the unleash-client you can easily check if a feature toggle is enabled or not.
|
|
|
|
```go
|
|
unleash.IsEnabled("app.ToggleX")
|
|
```
|
|
|
|
### 4. Stop unleash {#4-stop-unleash}
|
|
|
|
To shut down the client (turn off the polling) you can simply call the destroy-method. This is typically not required.
|
|
|
|
unleash.Close()
|
|
|
|
### Built-in activation strategies {#built-in-activation-strategies}
|
|
|
|
The Go client comes with implementations for the built-in activation strategies provided by unleash.
|
|
|
|
- DefaultStrategy
|
|
- UserIdStrategy
|
|
- FlexibleRolloutStrategy
|
|
- GradualRolloutUserIdStrategy
|
|
- GradualRolloutSessionIdStrategy
|
|
- GradualRolloutRandomStrategy
|
|
- RemoteAddressStrategy
|
|
- ApplicationHostnameStrategy
|
|
|
|
Read more about the strategies in [the activation strategies document](../user_guide/activation_strategy).
|
|
|
|
### Unleash context {#unleash-context}
|
|
|
|
In order to use some of the common activation strategies you must provide an [_Unleash context_](../user_guide/unleash-context.md). This client SDK allows you to send in the unleash context as part of the `isEnabled` call:
|
|
|
|
```go
|
|
ctx := context.Context{
|
|
UserId: "123",
|
|
SessionId: "some-session-id",
|
|
RemoteAddress: "127.0.0.1",
|
|
}
|
|
|
|
unleash.IsEnabled("someToggle", unleash.WithContext(ctx))
|
|
```
|
|
|
|
Read more at [github.com/Unleash/unleash-client-go](https://github.com/Unleash/unleash-client-go)
|