mirror of
https://github.com/Unleash/unleash.git
synced 2024-10-18 20:09:08 +02:00
d5fbd0b743
## What This (admittedly massive) PR updates the "physical" documentation structure and fixes url inconsistencies and SEO problems reported by marketing. The main points are: - remove or move directories : advanced, user_guide, deploy, api - move the files contained within to the appropriate one of topics, how-to, tutorials, or reference - update internal doc links and product links to the content - create client-side redirects for all the urls that have changed. A number of the files have been renamed in small ways to better match their url and to make them easier to find. Additionally, the top-level api directory has been moved to /reference/api/legacy/unleash (see the discussion points section for more on this). ## Why When moving our doc structure to diataxis a while back, we left the "physical' files lying where they were, because it didn't matter much to the new structure. However, that did introduce some inconsistencies with where you place docs and how we organize them. There's also the discrepancies in whether urls us underscores or hyphens (which isn't necessarily the same as their file name), which has been annoying me for a while, but now has also been raised by marketing as an issue in terms of SEO. ## Discussion points The old, hand-written API docs have been moved from /api to /reference/api/legacy/unleash. There _is_ a /reference/api/unleash directory, but this is being populated by the OpenAPI plugin, and mixing those could only cause trouble. However, I'm unsure about putting /legacy/ in the title, because the API isn't legacy, the docs are. Maybe we could use another path? Like /old-docs/ or something? I'd appreciate some input on this.
84 lines
2.4 KiB
Markdown
84 lines
2.4 KiB
Markdown
---
|
|
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](../../how-to/how-to-create-api-tokens.mdx)
|
|
|
|
### 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("https://unleash.example.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](../../reference/activation-strategies.md).
|
|
|
|
### Unleash context {#unleash-context}
|
|
|
|
In order to use some of the common activation strategies you must provide an [_Unleash context_](../../reference/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)
|