override_api_endpoint 1.0.0%2B3

Published Aug 12, 2025
SDKflutter
Platformandroidioswindowslinuxmacosweb

This package is prepared so that backend developers can override api endpoint for some local one without the need to compile the app. The desired behavior is realized with deeplinks. The override URL is persisted until a new deeplink is used.

override_api_endpoint

override_api_endpoint pub.dev badge

Overrides and persists default API endpoint for the test environment.

  • deeplinkOverrideSegment - part of deeplink that uniquely identifies deeplink that is used to override API endpoint eg. override in app://app/override?apiAddress=https%3A%2F%2Fexample.com
  • deeplinkQueryParameter - query parameter of the override API endpoint deeplink that contains url encoded API endpoint to be used eg. apiAddress in app://app/override?apiAddress=https%3A%2F%2Fexample.com
  • defaultEndpoint - fallback URL that should be used if app does not have any endpoint introduced via deeplink or if deeplinkQueryParameter is not provided

Usage

import 'package:shared_preferences/shared_preferences.dart';
import 'package:uni_links/uni_links.dart';

final apiEndpoint = await overrideApiEndpoint(
  sharedPreferences: await SharedPreferences.getInstance(),
  getInitialUri: getInitialUri,
  deeplinkOverrideSegment: 'override',
  deeplinkQueryParameter: 'apiAddress',
  defaultEndpoint: Uri.parse('https://api.example.com'),
);