Close Menu

rzvinyl

Introduction

RZVinyl is a lightweight and flexible Swift framework for working with JSON and Codable objects. It provides a convenient and intuitive way to map JSON data to custom Swift objects and vice versa. With RZVinyl, you can easily serialize and deserialize JSON data without the need for manual mapping code.

Installation

To install RZVinyl in your project, follow these steps:

  • Open your project in Xcode
  • Go to “File” > “Swift Packages” > “Add Package Dependency”
  • In the search field, enter “RZVinyl”
  • Select the latest version and click “Next”
  • Choose the target where you want to add RZVinyl and click “Finish”

Usage

Using RZVinyl is straightforward. Simply follow the steps below to get started:

  1. Create a custom Swift object that conforms to the Codable protocol
  2. Define the properties of your object and annotate them with the corresponding JSON keys
  3. For example:

struct User: Codable {
    let id: Int
    let name: String
    let email: String
    
    enum CodingKeys: String, CodingKey {
        case id
        case name = "full_name"
        case email
    }
}

Now, you can use RZVinyl to parse JSON data into your custom objects or convert your objects into JSON. Here are some examples:

  • To parse JSON into objects:

let jsonData = """
{
    "id": 1,
    "full_name": "John Doe",
    "email": "john.doe@example.com"
}
""".data(using: .utf8)!

let user = try? RZVinyl.parse(User.self, from: jsonData)

  • To convert objects into JSON:

let user = User(id: 1, name: "John Doe", email: "john.doe@example.com")

let json = RZVinyl.convertToJson(user)

Support

If you encounter any issues or have questions about RZVinyl, please visit the GitHub repository for more information. You can also submit bug reports or feature requests on the repository’s issue tracker.

Conclusion

RZVinyl provides a seamless way to work with JSON data in Swift, eliminating the need for manual mapping code. With its simplicity and flexibility, you can easily serialize and deserialize JSON objects effortlessly. Give RZVinyl a try in your next Swift project!