api-reflector

A configurable API mocking service.

Development

api-reflector uses poetry for dependency management.

It is recommended that you use poetry 1.2+ along with poetry-dotenv-plugin for easier project configuration.

$ poetry install
$ poetry shell
$ api-reflector-migrate
$ flask run

All configuration is done via environment variables. If you are using poetry-dotenv-plugin or another dotenv tool, you can use a .env file in the project root to set configuration variables. .env.example is provided as an example. If you use the example dotenv file, make sure you update secret_key.

Azure auth

Azure SSO can be enabled by setting azure_auth_enabled to true in your environment. If Azure SSO is enabled, three extra environment variables need to be provided:

azure_client_id
azure_client_secret
azure_tenant

Local Testing

By default, insecure redirect URLS will be rejected. If you want to test locally, set OAUTHLIB_INSECURE_TRANSPORT=true in your environment.

Docker-compose

Spin up postgres and api reflector containers with docker compose:

From project root:

docker-compose -f docker-compose-local.yml up

Exposed ports:

posgtres: 5438

apireflector: Go to browser on http://localhost:6502

Required Kubernetes Annotations for Ingress

If you use an external service for proxying traffic into your Kubernetes clusters such as Azure Front Door or Cloudflare, you'll need to pass the following example annotation:

apiVersion: networking.k8s.io/v1
kind: Ingress
metadata:
  annotations:
    nginx.ingress.kubernetes.io/upstream-vhost: reflector.example.com # <-- this one right here.