How do I set up Waterwheel with Drupal 8 for my iOS app?

Install Waterwheel via CocoaPods or Carthage, import the module, set your Drupal site URL using waterwheel.setDrupalURL(), and configure authentication methods like Basic Auth or cookie-based login. The SDK provides built-in UI components and entity methods for quick integration.

Waterwheel vs using Alamofire directly for Drupal API calls?

Waterwheel offers Drupal-specific abstractions like entity management and authentication out of the box, while Alamofire requires manual implementation of Drupal's API structures. Choose Waterwheel for faster Drupal integration, but Alamofire if you need flexibility for non-Drupal APIs.

Can Waterwheel handle user logout and session persistence?

Yes, Waterwheel manages user sessions automatically with persistence across app sessions, and provides methods for login and logout, including built-in UI components like AuthButton that handle state transitions seamlessly.

How to cache data locally with Waterwheel to improve performance?

Waterwheel includes local caching features that store API responses on the device. Enable it in configuration, and the SDK handles cache invalidation and retrieval transparently, reducing network latency for repeated requests.

Is Waterwheel compatible with watchOS and tvOS?

Yes, Waterwheel supports watchOS, tvOS, macOS, and iOS with a unified API, as indicated in the platform requirements. This makes it suitable for building cross-platform Apple applications with Drupal backends.

What are the alternatives to Waterwheel for connecting iOS apps to Drupal?

Alternatives include using Drupal's REST API directly with libraries like Alamofire, or older SDKs like Drupal iOS SDK (Obj-C version). Waterwheel is the modern Swift-based option specifically designed for Drupal 8 and later.

Open-Awesome

waterwheel.swift

MITSwift4.3.4

A Swift SDK for natively connecting iOS, macOS, tvOS, and watchOS applications to Drupal 7 and 8 backends.

Visit Website GitHub

410 stars91 forks0 contributors

What is waterwheel.swift?

Waterwheel is a Swift SDK that enables native Apple platform applications (iOS, macOS, tvOS, watchOS) to connect to Drupal 7 and 8 backends. It provides a comprehensive set of tools for authentication, entity management, and data synchronization, solving the problem of complex Drupal API integration for mobile and desktop apps.

Target Audience

iOS/macOS/tvOS/watchOS developers building applications that need to interact with Drupal-based content management systems, particularly those creating content-driven apps with user authentication and dynamic data.

Value Proposition

Developers choose Waterwheel because it provides a native Swift interface specifically designed for Drupal integration, with built-in authentication UI components, entity management, and local caching that significantly reduces development time compared to manual API implementation.

Overview

The Waterwheel Swift SDK provides classes to natively connect iOS, macOS, tvOS, and watchOS applications to Drupal 7 and 8.

Use Cases

Best For

Building iOS apps that display content from Drupal websites
Creating cross-platform Apple applications with Drupal backend synchronization
Implementing user authentication in Drupal-powered mobile apps
Developing content management applications for tvOS or watchOS
Managing Drupal entities (nodes, users) from native Swift code
Integrating Drupal Views with native iOS table views

Not Ideal For

Projects using non-Drupal CMS platforms like WordPress or custom backends
Applications requiring advanced real-time features not supported by Drupal's core REST APIs
Teams preferring general-purpose networking libraries (e.g., Alamofire) for more control over API interactions

Pros & Cons

Pros

Comprehensive Drupal Integration

Provides full CRUD operations for Drupal entities and built-in authentication methods, abstracting away the complexities of Drupal's REST APIs as shown in the entity and node method examples.

Built-in Authentication UI

Includes ready-to-use LoginViewController and AuthButton components, speeding up login flow implementation without custom UI work, as demonstrated in the usage section.

Cross-Apple Platform Support

Unified API works across iOS, macOS, tvOS, and watchOS, enabling consistent development for all Apple devices, as highlighted in the platform badges and requirements.

Local Caching for Performance

Caches API responses locally on the device to reduce network calls and improve app responsiveness, a key feature mentioned in the README's capabilities.

Cons

Drupal Version Fragmentation

Requires matching Waterwheel versions to specific Drupal releases (e.g., Swift for Drupal 8 only, Obj-C for older versions), complicating upgrades and compatibility, as noted in the Drupal Compatibility section.

Non-HTTPS Setup Complexity

Needs manual configuration of App Transport Security for HTTP connections, adding an extra step in development setup, as warned in the Configuration notes.

Closure-Heavy API Design

Relies extensively on Swift closures for asynchronous operations, which can be confusing for developers new to functional programming patterns, as emphasized in the usage examples.

Frequently Asked Questions

Related Projects

Swifter

[DEPRECATED] :bird: A Twitter framework for iOS & OS X written in Swift

Stars2,352

Forks374

Last commit4 years ago

SlackKit

Build Slack apps, in Swift

Stars1,013

Forks135

Last commit3 years ago

STTwitter

A stable, mature and comprehensive Objective-C library for Twitter REST API 1.1

Stars989

Forks157