使用 OpenFeature 评估 Flagship 功能标志。
OpenFeature ↗ 是功能标志接口的 CNCF 标准。它提供了一个独立于供应商的 API,因此您可以在不更改评估代码的情况下切换标志提供商。
Flagship 为 TypeScript、Python 和 Go 提供了官方兼容 OpenFeature 的 SDK。源代码可在 GitHub ↗ 上找到。
| SDK | 包 | 运行时 | 评估模式 |
|---|---|---|---|
| TypeScript | @cloudflare/flagship ↗ |
Workers、Node.js、浏览器 | Workers 绑定、HTTP、浏览器预取缓存 |
| Python | cloudflare-flagship ↗ |
Python 服务器应用程序 | HTTP |
| Go | github.com/cloudflare/flagship/sdks/go ↗ |
Go 服务器应用程序 | HTTP |
Flagship SDK 按语言组织。TypeScript SDK 为服务器端和浏览器用法提供了单独的设置指南,因为它们使用不同的 OpenFeature 包和运行时行为。
- TypeScript Server SDK — 适用于 Workers、Node.js 和其他服务器端 JavaScript 运行时。
- TypeScript Client SDK — 适用于需要同步 OpenFeature web SDK 评估的浏览器应用程序。
- Python SDK — 适用于 Python 服务器应用程序。
- Go SDK — 适用于 Go 服务器应用程序。
从 0.6.0 版开始,TypeScript、Python 和 Go SDK 支持结构化上下文。上下文支持取决于评估客户端和传输方式:
| 客户端或 API | 上下文支持 |
|---|---|
| 直接 Workers 绑定 | 递归 JSON 值;有效的 Date 值会规范化为字符串 |
| TypeScript 服务提供程序 | 递归 JSON 值和 Date,支持通过 binding 或 HTTP 进行评估 |
| TypeScript 客户端提供程序 | 递归 JSON 值和 Date |
| Python 提供程序 | 递归 JSON 值和 datetime |
| Go 提供程序 | 递归 JSON 值和 time.Time |
| Wrangler | 每个 --context 参数中的字符串值 |
评估 API POST |
递归 JSON 值 |
SDK 通过 HTTP 使用 POST 发送结构化上下文。仅包含字符串、数字、布尔值或日期的上下文使用 GET 查询参数。日期会规范化为字符串,包括嵌套对象和数组中的日期。
在不使用 SDK 发送结构化上下文时,请使用评估 API POST 端点。
对于 TypeScript 服务器端用法:
npm i @cloudflare/flagship @openfeature/server-sdkyarn add @cloudflare/flagship @openfeature/server-sdkpnpm add @cloudflare/flagship @openfeature/server-sdkbun add @cloudflare/flagship @openfeature/server-sdk对于 TypeScript 浏览器用法:
npm i @cloudflare/flagship @openfeature/web-sdkyarn add @cloudflare/flagship @openfeature/web-sdkpnpm add @cloudflare/flagship @openfeature/web-sdkbun add @cloudflare/flagship @openfeature/web-sdk对于 Python:
uv add cloudflare-flagship对于 Go:
go get github.com/cloudflare/flagship/sdks/go- 为 Workers、Node.js 或其他服务器端运行时设置服务器提供商。
- 为浏览器应用程序设置客户端提供商。
- 为 Python 服务器应用程序设置 Python SDK。
- 为 Go 服务器应用程序设置 Go SDK。