environment-based-client-initialization.md

Environment-Based Client Initialization

The SDK client can also be initialized directly from environment variables using the from_env class method. This allows the SDK to automatically read configuration values from the runtime environment or a .env file.

require 'medium_api'
include MediumApi

# Create client from environment
client = Client.from_env

You can also load values from a .env file before creating the client. To do this, install and use the dotenv gem:

gem install dotenv

Now require 'dotenv/load' automatically loads all variables from a .env file into ENV, so the from_env method can access them.

require 'dotenv/load'
require 'medium_api'
include MediumApi

# Create client from environment
client = Client.from_env

The same method can accept keyword arguments to override any values read from the environment.

# To override or fill in values that are not set in the environment, pass them
# as keyword arguments when calling `from_env`
client = Client.from_env(environment: 'production', timeout: 30)

Values provided through arguments take precedence over those defined in environment variables.

Example .env File

ENVIRONMENT='production'

API_HOST_X_RAPIDAPI_HOST='xRapidapiHost'
API_KEY_X_RAPIDAPI_KEY='xRapidapiKey'

TIMEOUT=60
MAX_RETRIES=3
BACKOFF_FACTOR=2
RETRY_INTERVAL=1
RETRY_STATUSES=408,413
RETRY_METHODS=GET,PUT,DELETE
PROXY_ADDRESS='http://localhost:3000'
PROXY_PORT=8080
PROXY_USERNAME='username'
PROXY_PASSWORD='password'

Note

• If an environment variable is not defined, the default SDK configuration value will be used.