Fast URL query encoder / decoder for Swift Codable types

URLQueryCoder

Requirements

  • iOS 10.0+ / macOS 10.12+ / watchOS 3.0+ / tvOS 10.0+
  • Xcode 12.5+
  • Swift 5.1+

Usage

struct User: Codable {
   var id: Int
   var name: String
}

// Encode to URL query
let user = User(id: 123, name: "Neo")
let query = try URLQueryEncoder().encode(user)

// Decode from URL query
let query = "id=123&name=Neo"
let user = try URLQueryDecoder().decode(User.self, from: query)

Installation

CocoaPods

CocoaPods is a dependency manager for Cocoa projects. You can install it with the following command:

$ gem install cocoapods

To integrate URLQueryCoder into your Xcode project using CocoaPods, specify it in your Podfile:

platform :ios, '10.0'
use_frameworks!

target '<Your Target Name>' do
    pod 'URLQueryCoder'
end

Finally run the following command:

$ pod install

Carthage

Carthage is a decentralized dependency manager that builds your dependencies and provides you with binary frameworks. You can install Carthage with Homebrew using the following command:

$ brew update
$ brew install carthage

To integrate URLQueryCoder into your Xcode project using Carthage, specify it in your Cartfile:

github "almazrafi/URLQueryCoder" ~> 1.0.0

Finally run carthage update to build the framework and drag the built URLQueryCoder.framework into your Xcode project.

Swift Package Manager

The Swift Package Manager is a tool for managing the distribution of Swift code. It’s integrated with the Swift build system to automate the process of downloading, compiling, and linking dependencies.

To integrate URLQueryCoder into your Xcode project using Swift Package Manager, add the following as a dependency to your Package.swift:

.package(url: "https://github.com/almazrafi/URLQueryCoder.git", from: "1.0.0")

and then specify "URLQueryCoder" as a dependency of the Target in which you wish to use URLQueryCoder.

Here’s an example Package.swift:

// swift-tools-version:5.1
import PackageDescription

let package = Package(
    name: "MyPackage",
    products: [
        .library(name: "MyPackage", targets: ["MyPackage"])
    ],
    dependencies: [
        .package(url: "https://github.com/almazrafi/URLQueryCoder.git", from: "1.0.0")
    ],
    targets: [
        .target(name: "MyPackage", dependencies: ["URLQueryCoder"])
    ]
)

Communication

  • If you need help, open an issue.
  • If you found a bug, open an issue.
  • If you have a feature request, open an issue.
  • If you want to contribute, submit a pull request.

License

URLQueryCoder is available under the MIT license. See the LICENSE file for more info.

GitHub

View Github