featbit/featbit-api-server repository overview

⁠About

FeatBit is an open-source feature flag management platform.⁠

This is the docker image of FeatBit's backend api server which intended for use by featbit-ui⁠.

You can find its source code here: https://github.com/featbit/featbit/tree/main/modules/back-end⁠.

⁠Usage

Type the following command to run the api server:

docker run -d -p 5000:5000 --name featbit-api featbitdocker/featbit-api-server:latest

After our api server started, you can go http://localhost:5000/swagger⁠ to check a list of apis provided by our server.

⁠Health Check

you have a few options to check the server's health status

⁠Dump Health Check

Dump Health Check don't check whether the application can connect to its dependencies, and often only exercise the most basic requirements of the application itself i.e. can it respond to an HTTP request. To do that, you can

• run docker inspect --format '{{json .State.Health}}' featbit-api | jq to check if container's STATUS is healthy
• run curl http://localhost:5000/health/liveness manually to check the application's liveness