You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/reference/other-technologies/ofrep.mdx
+10-15Lines changed: 10 additions & 15 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -12,8 +12,7 @@ The **OpenFeature Remote Evaluation Protocol (OFREP)** is an API specification f
12
12
-**Vendor Agnostic**: Connect to any OFREP-compliant flag management system without vendor-specific implementations
13
13
-**Standardized**: Built on a common OpenAPI specification for consistent integration
14
14
-**Flexible**: Works on both client-side and server-side applications
15
-
-**Community Maintained**: Generic OFREP providers maintained by the OpenFeature community
16
-
-**Simple Migration**: Switch between flag management systems without changing application code
15
+
-**Community Maintained**: Generic OFREP providers maintained by the OpenFeature project
17
16
18
17
## How It Works
19
18
@@ -39,13 +38,13 @@ OFREP supports both paradigms defined by OpenFeature:
39
38
#### Server-Side (Dynamic Context)
40
39
41
40
- Evaluation happens by calling the OFREP API with context
42
-
-No in-process evaluation inside OFREP providers, API request made on every evaluation.
43
-
- Context changes frequently (per request, per user)
41
+
-API request with evaluation context is made on every evaluation
42
+
- Context per evaluation
44
43
45
44
#### Client-Side (Static Context)
46
45
47
-
-Evaluation happens locally with pre-fetched flag data
48
-
-Provider reconciles state using the OFREP API when context changes
46
+
-All flags are evaluated in one OFREP API call using a common static context
47
+
-Then local flag evaluation happens against the cached static context
49
48
- Context represents a single user or session
50
49
51
50
## Using OFREP
@@ -56,7 +55,7 @@ The OpenFeature community maintains OFREP providers for multiple languages. View
56
55
57
56
### Available Flag Management Systems
58
57
59
-
Many flag management systems support OFREP. View the complete list of [OFREP-compliant systems in the ecosystem](https://openfeature.dev/ecosystem/?instant_search%5BrefinementList%5D%5Btype%5D%5B0%5D=OFREP%20API).
58
+
Several flag management systems support OFREP. View the complete list of [OFREP-compliant systems in the ecosystem](https://openfeature.dev/ecosystem/?instant_search%5BrefinementList%5D%5Btype%5D%5B0%5D=OFREP%20API).
60
59
61
60
## Implementing OFREP
62
61
@@ -65,18 +64,14 @@ Many flag management systems support OFREP. View the complete list of [OFREP-com
65
64
To create an OFREP provider for a new language:
66
65
67
66
1. Review the [server provider guideline](https://github.com/open-feature/protocol/blob/docs-update-readme-for-website/guideline/dynamic-context-provider.md) or [client provider guideline](https://github.com/open-feature/protocol/blob/docs-update-readme-for-website/guideline/static-context-provider.md)
68
-
2. Implement the provider interface for your SDK
69
-
3. Add HTTP client logic to call OFREP endpoints
70
-
4. Handle error cases and response codes according to the specification
71
-
5. Register your provider in the [OpenFeature ecosystem](https://github.com/open-feature/openfeature.dev/issues)
67
+
2. Implement the provider for your SDK according to the guidelines
68
+
3. Register your provider in the [OpenFeature ecosystem](https://github.com/open-feature/openfeature.dev/issues)
72
69
73
70
### For Flag Management System Developers
74
71
75
72
To make your flag management system OFREP-compliant:
76
73
77
74
1. Implement the [OFREP OpenAPI specification](https://github.com/open-feature/protocol/blob/docs-update-readme-for-website/service/openapi.yaml)
78
-
2. Expose OFREP endpoints at `/ofrep/v1/evaluate/...`
79
-
3. Support both bulk evaluation (for client-side) and single flag evaluation (for server-side)
80
-
4. Test your implementation with existing OFREP providers
81
-
5. Register your system in the [OpenFeature ecosystem](https://github.com/open-feature/openfeature.dev/issues)
75
+
2. Test your implementation with existing OFREP providers
76
+
3. Register your system in the [OpenFeature ecosystem](https://github.com/open-feature/openfeature.dev/issues)
0 commit comments