This document describes how to integrate Flipt in your existing applications.
To learn how to install and run Flipt, see the Installation documentation.
Once you have the Flipt server up and running within your infrastructure, the next step is to integrate the Flipt client(s) with your applications that you would like to be able to use with Flipt.
There are two ways to communicate with the Flipt server:
- GRPC API
- REST API
We have also developed several clients in various languages for easier integration.
GRPC + REST SDKs
These SDKs support both Flipt’s gRPC and HTTP RPC APIs:
Since Flipt is a GRPC enabled application, you can use a generated GRPC client for your language of choice.
This means that your application can use the Flipt GRPC client if it is written in one of the many languages that GRPC supports, including:
- Android Java
An example Go application exists here, showing how you would integrate with Flipt using the Go GRPC client.
Official Flipt GRPC clients are currently available for the following languages:
If your language is not listed, please see the section below on how to generate a native GRPC client manually. If you choose to open-source this client, please submit a pull request so I can add it to the docs.
If a GRPC client in your language is not available for download, you can easily generate it yourself using the existing protobuf definition. The GRPC documentation has extensive examples of how to generate GRPC clients in each supported language.
GRPC generates both client implementation and server interfaces. To use Flipt you only need the GRPC client implementation and can ignore the server code as this is implemented by Flipt itself.
Below are two examples of how to generate Flipt clients in both Go and Ruby.
- Follow setup here
- Generate using protoc to desired location:
protoc -I ./rpc --go_out=plugins=grpc:/tmp/flipt/go ./rpc/flipt.proto cd /tmp/flipt/go/flipt ls flipt.pb.go flipt_pb.rb flipt_services_pb.
- Follow setup here
- Generate using protoc to the desired location:
grpc_tools_ruby_protoc -I ./rpc --ruby_out=/tmp/flipt/ruby --grpc_out=/tmp/flipt/ruby ./rpc/flipt.proto cd /tmp/flipt/ruby ls flipt_pb.rb flipt_services_pb.rb
Flipt also comes equipped with a fully functional REST API. The Flipt UI is completely backed by this same API. This means that anything that can be done in the Flipt UI can also be done via the REST API.
The Flipt REST API can also be used with any language that can make HTTP requests. This means that you don’t need to use one of the above GRPC clients to integrate your application with Flipt.
The latest version of the REST API is fully documented using the OpenAPI v3 specification as well as the above API Reference.
Official Flipt REST clients are currently available in the following languages:
You can use openapi-generator to generate client code in your preferred language from the Flipt OpenAPI v3 specification.
While generating clients is outside of the scope of this documentation, an example of generating a Java client with the
openapi-generator is below.
- Generate using
openapi-generator-clito desired location:
openapi-generator generate -i openapi.yml -g java -o /tmp/flipt/java
Third-Party Client Libraries
Client libraries built by awesome people from the Open Source community:
These libraries are not maintained by the Flipt team and may not be up to date with the latest version of Flipt. Please open an issue or pull request on the library’s repository if you find any issues.
|flipt-grpc-python||Python||@getsentry||Python GRPC bindings for Flipt|
|rflipt||React||@christopherdiehl||Components/example project to control React features backed by Flipt|
|flipt-php||PHP||@fetzi||Package for evaluating feature flags via the Flipt REST API using HTTPlug|