Mirrors/unleash.unleash
1
0
Fork 0
mirror of https://github.com/Unleash/unleash.git synced 2024-12-22 19:07:54 +01:00
Code Issues Projects Releases Wiki Activity

docs(compat): Flesh out descriptions

Browse Source
This commit is contained in:
Thomas Heartman 2021-12-09 13:33:30 +01:00
parent abc07ae73f
commit 828468dfe5
1 changed files with 31 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

57
website/docs/sdks/index.md
View File

@ -4,11 +4,15 @@ title: Introduction
slug: /sdks
---
In order to connect your application to Unleash you need to use a client SDK (software developer kit) for your programming language. In addition you will need a [API token](../user_guide/api-token). The SDK will handle connecting to the Unleash server instance and retrieve feature toggles based upon your configuration. Both open-source and the Unleash enterprise offering utilize the same set of client SDKs.
In order to connect your application to Unleash you will need a client SDK (software developer kit) for your programming language and an [API token](../user_guide/api-token). The SDK will handle connecting to the Unleash server instance and retrieving feature toggles based on your configuration. All versions of Unleash (OSS, Pro, and Enterprise) use the same client SDKs.
On this page you will find examples for connecting your application to the demo instance. If you are connecting to your own private instance you will have to remember to replace the `API token` and the `API url` given in the examples.
Unleash provides official client SDKs for a number of programming language. Additionally, our community have developed and contributed SDKs for other languages. So if you can't find your favorite language in the list of official SDKs, check out the [list of clients written by our fantastic community](#clients-written-by-awesome-enthusiasts).
**Official Server SDKs**:
## Official SDKs
### Server-side SDKs:
Server-side clients run on your server and communicate directly with your Unleash instance. We provide these official clients:
- [Java SDK](/sdks/java_sdk)
- [Node.js SDK](/sdks/node_sdk)
@ -18,7 +22,9 @@ On this page you will find examples for connecting your application to the demo
- [.Net SDK](/sdks/dot_net_sdk)
- [PHP SDK](/sdks/php_sdk)
**Official Frontend Unleash Proxy SDKs:**
### Front-end SDKs
For security and performance reasons, the front-end SDKs do not communicate directly with your Unleash instance. Instead, they go via the [Unleash Proxy](unleash-proxy.md).
- [Javascript SDK](/sdks/proxy-javascript)
- [Android SDK](/sdks/android_proxy_sdk)
@ -26,9 +32,9 @@ On this page you will find examples for connecting your application to the demo
- [React Proxy SDK](/sdks/proxy-react)
## SDK compatibility
### Server-side SDK compatibility table
...
The below table shows what features the various server-side SDKs support. Note that certain features make sense only for some clients due to how the programming language works or due to how the client works.
**Legend**:
@ -37,63 +43,64 @@ On this page you will find examples for connecting your application to the demo
- ❌: Not implemented, not planned
- **N/A**: Not applicable to this SDK
:::note
If you see an item marked with a ❌ that you would find useful, feel free to reach out to us with your use case. It may not be something we can prioritize right now, but if you'd like to contribute it back to the community, we'd love to help you build it.
:::
### Server SDKs
Some of
| Capability | Java | Node.js | Go | Python | Ruby | .Net | PHP | Unleash Proxy Server |
|------------------------------------------|------|---------|-----|--------|------|------|-----|----------------------|
| **Initialization** | | | | | | | | |
| **Category: Initialization** | | | | | | | | |
| Async initialization | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | N/A |
| Can block until synchronized | ✅ | ✅ | ⭕ | ⭕ | ⭕ | ✅ | ⭕ | N/A |
| Refresh interval - default | 10s | 15s | 15s | 15s | 15s | 30s | 30s | 5s |
| Metrics interval - default | 60s | 60s | 60s | 60s | 30s | 60s | 30s | 30s |
| Default refresh interval | 10s | 15s | 15s | 15s | 15s | 30s | 30s | 5s |
| Default metrics interval | 60s | 60s | 60s | 60s | 30s | 60s | 30s | 30s |
| Context provider | ✅ | N/A | N/A | N/A | N/A | ✅ | ✅ | N/A |
| Global fallback function | ✅ | ✅ | ✅ | ✅ | ❌ | ❌ | ❌ | N/A |
| Toggle Query: `namePrefix` | ✅ | ✅ | ❌ | ❌ | ❌ | ❌ | ❌ | ✅ |
| Toggle Query: `tags` | ✅ | ✅ | ❌ | ❌ | ❌ | ❌ | ❌ | ✅ |
| Toggle Query: `project_name` | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | N/A | ✅ |
| **Custom Headers** | | | | | | | | |
| **Category: Custom Headers** | | | | | | | | |
| static | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | N/A |
| function | ✅ | ✅ | ⭕ | ✅ | ⭕ | ✅ | ⭕ | N/A |
| **Built-in strategies** | | | | | | | | |
| **Category: Built-in strategies** | | | | | | | | |
| standard | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
| `flexibleRollout` | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
| `flexibleRollout`: custom stickiness | ✅ | ✅ | ⭕ | ✅ | ⭕ | | ✅ | ✅ |
| `flexibleRollout`: custom stickiness | ✅ | ✅ | ⭕ | ✅ | ⭕ | ? | ✅ | ✅ |
| `userWithID` | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
| `remoteAddress` | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
| `remoteAddress`: CIDR syntax | ✅ | ✅ | ✅ | ✅ | ⭕ | ⭕ | ⭕ | ✅ |
| `applicationHostname` | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
| **Custom strategies** | | | | | | | | |
| **Category: Custom strategies** | | | | | | | | |
| Basic support | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
| **Strategy constraints** | | | | | | | | |
| **Category:Strategy constraints** | | | | | | | | |
| Basic support (`IN`, `NOT_IN` operators) | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
| **Unleash Context** | | | | | | | | |
| **Category: Unleash Context** | | | | | | | | |
| Static fields (`environment`, `appName`) | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
| Defined fields | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
| Custom properties | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
| **`isEnabled`** | | | | | | | | |
| **Category: `isEnabled`** | | | | | | | | |
| Can take context | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
| Override fallback value | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
| Fallback function | ✅ | ✅ | ✅ | ✅ | ✅ | ⭕ | ⭕ | ✅ |
| **Variants** | | | | | | | | |
| **Category: Variants** | | | | | | | | |
| Basic support | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
| Custom fallback variant | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
| Custom weight | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
| Custom stickiness (beta) | ✅ | ✅ | ⭕ | ✅ | ⭕ | ⭕ | ✅ | ✅ |
| **Local backup** | | | | | | | | |
| **Category: Local backup** | | | | | | | | |
| File based backup | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
| **Usage metrics** | | | | | | | | |
| **Category: Usage metrics** | | | | | | | | |
| Can disable metrics | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
| Client registration | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
| Basic usage metrics (yes/no) | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
| **Bootstrap (beta)** | | | | | | | | |
| **Category: Bootstrap (beta)** | | | | | | | | |
| Bootstrap from file | ✅ | ⭕ | ⭕ | ⭕ | ⭕ | ⭕ | ⭕ | ⭕ |
| Custom Bootstrap implementation | ✅ | ⭕ | ⭕ | ⭕ | ⭕ | ⭕ | ⭕ | ⭕ |
## Clients written by awesome enthusiasts: {#clients-written-by-awesome-enthusiasts}
## Clients written by awesome enthusiasts {#clients-written-by-awesome-enthusiasts}
Here's some of the fantastic work our community has done to make Unleash work in even more contexts. If you still can't find your favorite language, let us know and we'd love to help you create the client for it!
- [cognitedata/unleash-client-rust](https://github.com/cognitedata/unleash-client-rust) (Rust)
- [silvercar/unleash-client-kotlin](https://github.com/silvercar/unleash-client-kotlin) (Kotlin)
@ -105,5 +112,3 @@ Some of
- [AppsFlyer/clojure-unleash](https://github.com/AppsFlyer/unleash-client-clojure) (Clojure)
- [pmb0/nestjs-unleash](https://github.com/pmb0/nestjs-unleash) (NestJS - Node.js)
- _...your implementation for your favorite language._
When you get access to your instance – [create a client secret](../user_guide/api-token), and we will provide you with your API url for your instance.