Close Menu

consumer

Welcome to the documentation for the Consumer framework. Here you will find all the information you need to get started with this powerful library. Consumer is designed to simplify data consumption and provide a clean, intuitive interface for working with APIs. Whether you are a beginner or an experienced developer, this documentation will guide you through the process of using Consumer effectively.

Installation and Setup

To begin using the Consumer framework in your project, you will need to follow these installation and setup steps:

  • Step 1: Open your Xcode project.
  • Step 2: Go to your project target settings.
  • Step 3: Select “General” and scroll down to “Frameworks, Libraries, and Embedded Content”.
  • Step 4: Click on the “+” button to add a new framework.
  • Step 5: Search for “Consumer.framework” and select it.
  • Step 6: Choose “Embed & Sign” as the “Embed” option.
  • Step 7: Click “Finish”.

Usage

Consumer offers a straightforward API for retrieving and manipulating data from APIs. To start using Consumer, follow the steps below:

  1. Create an instance of the `Consumer` class.
  2. Set the necessary request parameters such as URL, headers, and HTTP method.
  3. Use the appropriate methods provided by `Consumer` to execute the request and handle the response.

Examples

Here are some examples that demonstrate how to use Consumer in different scenarios:

Basic GET Request

This example shows how to make a simple GET request using Consumer:

import Consumer

let consumer = Consumer()

consumer.get("https://api.example.com/users") { response in
    switch response.result {
    case .success(let data):
        // Handle successful response
    case .failure(let error):
        // Handle error
    }
}

POST Request with Headers

This example demonstrates how to make a POST request with custom headers:

import Consumer

let consumer = Consumer()

let headers = [
    "Authorization": "Bearer YOUR_API_TOKEN",
    "Content-Type": "application/json"
]

let parameters = [
    "name": "John Doe",
    "email": "john.doe@example.com"
]

consumer.post("https://api.example.com/users", headers: headers, parameters: parameters) { response in
    switch response.result {
    case .success(let data):
        // Handle successful response
    case .failure(let error):
        // Handle error
    }
}

Advanced Configuration

Consumer provides several advanced configuration options to customize its behavior. These options include:

Response Validation

Consumer allows you to define custom response validation rules. This can be useful for checking the validity and integrity of the returned data. Here’s an example of how to define a custom validation rule:

consumer.validate { request, response, data in
    return .success
}

Authentication

Consumer supports various authentication methods including OAuth 2.0, API keys, and basic authentication. To authenticate a request, use the `authenticate` method:

consumer.authenticate(.bearer(token: "YOUR_API_TOKEN"))

Error Handling

Consumer provides a built-in error handling mechanism that allows you to handle errors in a consistent way. You can customize the error handling behavior by conforming to the `ConsumerErrorHandling` protocol:

extension YourClass: ConsumerErrorHandling {
    func handle(_ error: Error) {
        // Handle the error here
    }
}

That concludes the documentation for the Consumer framework. With its intuitive API, advanced configuration options, and built-in error handling, Consumer is a powerful tool for working with APIs. We hope this documentation has provided you with the necessary information to get started and use Consumer effectively in your projects. Happy coding!