Mirrors/unleash.unleash
1
0
Fork 0
mirror of https://github.com/Unleash/unleash.git synced 2024-12-28 00:06:53 +01:00
Code Issues Projects Releases Wiki Activity
184a18ba41
unleash.unleash/website/docs/sdks/index.md

122 lines
20 KiB
Markdown
Raw Normal View History

chore: fix SDK docs
2021-05-04 16:08:21 +02:00
---
id: index
title: Introduction
fix: slug for /sdks
2021-06-04 14:10:37 +02:00
slug: /sdks
chore: fix SDK docs
2021-05-04 16:08:21 +02:00
---
docs(compat): Flesh out descriptions
2021-12-09 13:33:30 +01:00
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.
chore: fix SDK docs
2021-05-04 16:08:21 +02:00
docs(compat): Flesh out descriptions
2021-12-09 13:33:30 +01:00
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).
chore: fix SDK docs
2021-05-04 16:08:21 +02:00
docs(compat): Flesh out descriptions
2021-12-09 13:33:30 +01:00
## Official SDKs
### Server-side SDKs:
Server-side clients run on your server and communicate directly with your Unleash instance. We provide these official clients:
chore: fix SDK docs
2021-05-04 16:08:21 +02:00
docs(chore): move Rust sdk from community to official listing Also sorts the list of SDKs by name.
2022-01-10 14:44:29 +01:00
- [Go SDK](/sdks/go_sdk)
fix: link to sdks
2021-06-04 14:38:11 +02:00
- [Java SDK](/sdks/java_sdk)
- [Node.js SDK](/sdks/node_sdk)
Add official php documentation (#920)
2021-08-19 13:34:05 +02:00
- [PHP SDK](/sdks/php_sdk)
docs(chore): move Rust sdk from community to official listing Also sorts the list of SDKs by name.
2022-01-10 14:44:29 +01:00
- [Python SDK](/sdks/python_sdk)
- [Ruby SDK](/sdks/ruby_sdk)
- [Rust SDK](https://github.com/unleash/unleash-client-rust)
docs(chore): sort the sdk list the same as the sidebar list.
2022-01-13 10:34:05 +01:00
- [.NET SDK](/sdks/dot_net_sdk)
fix: add details about the proxy
2021-06-04 13:44:34 +02:00
docs(compat): Flesh out descriptions
2021-12-09 13:33:30 +01:00
### 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).
fix: add details about the proxy
2021-06-04 13:44:34 +02:00
chore: add docs for android-proxy-sdk (#865) * chore: add docs for android-proxy-sdk * chore: link back to android-proxy from sdk docs
2021-06-04 14:48:15 +02:00
- [Android SDK](/sdks/android_proxy_sdk)
fix: add details about ios proxy sdk
2021-06-04 13:52:32 +02:00
- [iOS Proxy SDK](/sdks/proxy-ios)
docs(chore): sort SDK lists alphabetically
2022-01-10 15:00:10 +01:00
- [Javascript SDK](/sdks/proxy-javascript)
Update index.md
2021-08-26 20:14:52 +02:00
- [React Proxy SDK](/sdks/proxy-react)
chore: fix SDK docs
2021-05-04 16:08:21 +02:00
docs(compat): add a first iteration of the compatibility table.
2021-12-09 13:14:20 +01:00
docs(compat): Flesh out descriptions
2021-12-09 13:33:30 +01:00
### Server-side SDK compatibility table
docs(compat): add a first iteration of the compatibility table.
2021-12-09 13:14:20 +01:00
docs(compat): Flesh out descriptions
2021-12-09 13:33:30 +01:00
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.
docs(compat): add a first iteration of the compatibility table.
2021-12-09 13:14:20 +01:00
**Legend**:
- ✅: Implemented
- ⭕: Not yet implemented, but we're looking into it
- ❌: Not implemented, not planned
- **N/A**: Not applicable to this SDK
docs(compat): Flesh out descriptions
2021-12-09 13:33:30 +01:00
:::note
docs(compat): add slack link to text
2021-12-09 13:54:06 +01:00
If you see an item marked with a ❌ that you would find useful, feel free to reach out to us ([on Slack](https://join.slack.com/t/unleash-community/shared_invite/zt-8b6l1uut-LL67kLpIXm9bcN3~6RVaRQ), for instance) 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.
docs(compat): Flesh out descriptions
2021-12-09 13:33:30 +01:00
:::
docs(compat): add a first iteration of the compatibility table.
2021-12-09 13:14:20 +01:00
docs(chore): standardize on the naming of the .NET sdk.
2022-01-13 10:34:55 +01:00
| Capability | [Java](/sdks/java_sdk) | [Node.js](/sdks/node_sdk) | [Go](/sdks/go_sdk) | [Python](/sdks/python_sdk) | [Ruby](/sdks/ruby_sdk) | [.NET](/sdks/dot_net_sdk) | [PHP](/sdks/php_sdk) | [Unleash Proxy Server](unleash-proxy.md) |
docs(compat): link to sdks in table headers, use human strat names.
2021-12-10 15:17:07 +01:00
|---------------------------------------------------------------------------------------------------|:----------------------:|:-------------------------:|:------------------:|:--------------------------:|:----------------------:|:-------------------------:|:--------------------:|:----------------------------------------:|
| **Category: Initialization** | | | | | | | | |
| Async initialization | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | N/A |
| Can block until synchronized | ✅ | ✅ | ⭕ | ⭕ | ⭕ | ✅ | ⭕ | N/A |
| Default refresh interval | 10s | 15s | 15s | 15s | 15s | 30s | 30s | 5s |
Update the default metrics interval for Ruby SDK (#1247) Note that the new metrics interval (60s) is only in master and a release with the new value is not yet created.
2022-01-08 11:51:19 +01:00
| Default metrics interval | 60s | 60s | 60s | 60s | 60s | 60s | 30s | 30s |
docs(compat): link to sdks in table headers, use human strat names.
2021-12-10 15:17:07 +01:00
| 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 | ✅ |
| **Category: Custom Headers** | | | | | | | | |
| static | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | N/A |
| function | ✅ | ✅ | ⭕ | ✅ | ⭕ | ✅ | ⭕ | N/A |
| **Category: Built-in strategies** | | | | | | | | |
| [Standard](../user_guide/activation_strategy#standard) | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
| [Gradual rollout](../user_guide/activation_strategy#gradual-rollout) | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
Update status of Ruby SDK after release 4.0.0
2021-12-16 21:03:25 +01:00
| [Gradual rollout: custom stickiness](../user_guide/activation_strategy#customize-stickiness-beta) | ✅ | ✅ | ⭕ | ✅ | ✅ | ✅ | ✅ | ✅ |
docs(compat): link to sdks in table headers, use human strat names.
2021-12-10 15:17:07 +01:00
| [UserID](../user_guide/activation_strategy#userids) | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
| [IP](../user_guide/activation_strategy#ips) | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
Update ruby SDK capabilities Ruby sdk now supports remote_address strategy with CIDR syntax Feature can be found in main branch, not in a release yet.
2022-01-11 22:44:14 +01:00
| [IP](../user_guide/activation_strategy#ips): CIDR syntax | ✅ | ✅ | ✅ | ✅ | ✅ | ⭕ | ⭕ | ✅ |
docs(compat): link to sdks in table headers, use human strat names.
2021-12-10 15:17:07 +01:00
| [Hostname](../user_guide/activation_strategy#hostnames) | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
| **Category: [Custom strategies](../advanced/custom_activation_strategy)** | | | | | | | | |
| Basic support | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
| **Category: [Strategy constraints](../advanced/strategy_constraints)** | | | | | | | | |
| Basic support (`IN`, `NOT_IN` operators) | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
| **Category: [Unleash Context](../user_guide/unleash_context)** | | | | | | | | |
| Static fields (`environment`, `appName`) | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
| Defined fields | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
| Custom properties | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
| **Category: [`isEnabled`](../client-specification#implementation-of-isenabled)** | | | | | | | | |
| Can take context | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
| Override fallback value | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
| Fallback function | ✅ | ✅ | ✅ | ✅ | ✅ | ⭕ | ⭕ | ✅ |
| **Category: [Variants](../advanced/toggle_variants)** | | | | | | | | |
| Basic support | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
| Custom fallback variant | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
| Custom weight | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
chore: correct compatibility matrix for server SDKs
2021-12-23 21:31:49 +01:00
| [Custom stickiness (beta)](../advanced/stickiness#custom-stickiness-beta) | ✅ | ✅ | ⭕ | ✅ | ✅ | ✅ | ✅ | ✅ |
docs(compat): link to sdks in table headers, use human strat names.
2021-12-10 15:17:07 +01:00
| **Category: Local backup** | | | | | | | | |
| File based backup | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
| **Category: Usage metrics** | | | | | | | | |
| Can disable metrics | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
| Client registration | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
| Basic usage metrics (yes/no) | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
| **Category: Bootstrap (beta)** | | | | | | | | |
| Bootstrap from file | ✅ | ⭕ | ⭕ | ⭕ | ⭕ | ⭕ | ⭕ | ⭕ |
| Custom Bootstrap implementation | ✅ | ⭕ | ⭕ | ⭕ | ⭕ | ⭕ | ⭕ | ⭕ |
docs(compat): add a first iteration of the compatibility table.
2021-12-09 13:14:20 +01:00
docs(chore): Update headings, slight sdk doc restructure.
2022-01-11 09:16:07 +01:00
## Community SDKs ❤️ {#community-sdks}
docs(compat): Flesh out descriptions
2021-12-09 13:33:30 +01:00
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!
chore: fix SDK docs
2021-05-04 16:08:21 +02:00
- [afontaine/unleash_ex](https://gitlab.com/afontaine/unleash_ex) (Elixir)
- [AppsFlyer/clojure-unleash](https://github.com/AppsFlyer/unleash-client-clojure) (Clojure)
docs(chore): sort SDK lists alphabetically
2022-01-10 15:00:10 +01:00
- [mikefrancis/laravel-unleash](https://github.com/mikefrancis/laravel-unleash) (Laravel - PHP)
- [minds/unleash-client-php](https://gitlab.com/minds/unleash-client-php) (PHP)
chore: fix SDK docs
2021-05-04 16:08:21 +02:00
- [pmb0/nestjs-unleash](https://github.com/pmb0/nestjs-unleash) (NestJS - Node.js)
docs(chore): sort SDK lists alphabetically
2022-01-10 15:00:10 +01:00
- [silvercar/unleash-client-kotlin](https://github.com/silvercar/unleash-client-kotlin) (Kotlin)
- [Stogon/unleash-bundle](https://git.stogon.io/Stogon/unleash-bundle/) (PHP - Symfony)
- [uekoetter.dev/unleash-client-dart](https://pub.dev/packages/unleash) (Dart)
chore: fix SDK docs
2021-05-04 16:08:21 +02:00
- _...your implementation for your favorite language._
docs: delete /sdks/community page This page was more or less a duplicate of the final section of the SDK overview. I've moved the section on implementing your own SDK into the SDK overview instead.
2022-01-10 14:53:41 +01:00
docs(chore): Update headings, slight sdk doc restructure.
2022-01-11 09:16:07 +01:00
## Implement your own SDK {#implement-your-own-sdk}
docs: delete /sdks/community page This page was more or less a duplicate of the final section of the SDK overview. I've moved the section on implementing your own SDK into the SDK overview instead.
2022-01-10 14:53:41 +01:00
If you can't find an SDK that fits your need, you can also develop your own SDK. To make implementation easier, check out these resources:
- [Unleash Client Specifications](https://github.com/Unleash/client-specification) - Used by all official SDKs to make sure they behave correctly across different language implementations. This lets us verify that a gradual rollout to 10% of the users would affect the same users regardless of which SDK you're using.
- [Client SDK overview](../client-specification) - A brief, overall guide of the _Unleash Architecture_ and important aspects of the SDK role in it all.
Reference in New Issue Copy Permalink