Sentry Answers>Swift>

Environment Variables in SwiftUI

Environment Variables in SwiftUI

Lazar Nikolov

The problemJump To Solution

In most of the cases well need to store some sort of a value or secret within our app. Whether thats an API key, or our backends URL. We might even want to provide different values for certain properties in Development mode and Production mode.

The Solution

Environment Variables are key-value properties that are defined in a certain place, and can be accessed from within the app. We usually use environment variables to store the API URL for both development and production, we also store our API keys that authorize our app with the backend. One of the super powers of the environment variables is the fact that they are stored in a separate file (that can be git-ignored!). Thats why its recommended to store your secrets as environment variables, so you dont leak them on GitHub.

To setup support for environment variables, we need to create a new Configuration Settings File in our project. So lets create a new group called Configs in our project and a new debug.xcconfig configuration file inside of it.

New file dialog

Empty configuration file view

Lets add a value:

Click to Copy
API_URL=debug.sentry.io/api

Now we need to set this file as the Debug configuration file for our project. Head to the Project Settings, and in the Configurations section, expand the Debug item and select the “debug” option for your project:

Setting the new configuration file in the Project Info settings

To make our API_URL variable available in our app, we also need to register it in our info.plist file. To do that:

  1. Click on the target and go to the Info tab
  2. Right click on any row in the “Custom Target Properties” and pick Add Row
  3. Set the key to API_URL and the value to $(API_URL)

Custom Target Properties

This step injects our environment variables into the “Info Dictionary”, and now we can access them in our code:

Click to Copy
if let apiUrl = Bundle.main.infoDictionary?["API_URL"] as? String { // we have our API_URL value! }
  • ResourcesSentry vs. Crashlytics: The Mobile Developer's Decision-Making Guide
  • SentrySwift Error & Performance Monitoring
  • Syntax.fm logo
    Listen to the Syntax Podcast

    Tasty treats for web developers brought to you by Sentry. Get tips and tricks from Wes Bos and Scott Tolinski.

    SEE EPISODES

Loved by over 4 million developers and more than 100,000 organizations worldwide, Sentry provides code-level observability to many of the world’s best-known companies like Disney, Peloton, Cloudflare, Eventbrite, Slack, Supercell, and Rockstar Games. Each month we process billions of exceptions from the most popular products on the internet.

© 2024 • Sentry is a registered Trademark
of Functional Software, Inc.