Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/almazrafi/urlquerycoder

Fast URL query encoder / decoder for Swift Codable types
https://github.com/almazrafi/urlquerycoder

carthage cocoapods codable decodable encodable ios macos spm swift tvos url url-query watchos xcode

Last synced: about 1 month ago
JSON representation

Fast URL query encoder / decoder for Swift Codable types

Host: GitHub
URL: https://github.com/almazrafi/urlquerycoder
Owner: almazrafi
License: mit
Created: 2022-08-30T10:56:01.000Z (over 2 years ago)
Default Branch: main
Last Pushed: 2022-11-03T13:24:46.000Z (about 2 years ago)
Last Synced: 2024-11-13T18:20:25.119Z (about 1 month ago)
Topics: carthage, cocoapods, codable, decodable, encodable, ios, macos, spm, swift, tvos, url, url-query, watchos, xcode
Language: Swift
Homepage:
Size: 80.1 KB
Stars: 19
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        # URLQueryCoder

[![Build Status](https://github.com/almazrafi/URLQueryCoder/workflows/CI/badge.svg?branch=main)](https://github.com/almazrafi/URLQueryCoder/actions)

[![Codecov](https://codecov.io/gh/almazrafi/URLQueryCoder/branch/main/graph/badge.svg?token=DRFk9RWXWB)](https://codecov.io/gh/almazrafi/URLQueryCoder)

[![Cocoapods](https://img.shields.io/cocoapods/v/URLQueryCoder)](http://cocoapods.org/pods/URLQueryCoder)

[![Carthage compatible](https://img.shields.io/badge/Carthage-Compatible-brightgreen.svg?style=flat)](https://github.com/Carthage/Carthage)

[![SPM compatible](https://img.shields.io/badge/SPM-Compatible-brightgreen.svg?style=flat)](https://swift.org/package-manager/)

[![Platforms](https://img.shields.io/cocoapods/p/URLQueryCoder)](https://developer.apple.com/discover/)

[![Xcode](https://img.shields.io/badge/Xcode-13-blue)](https://developer.apple.com/xcode)

[![Swift](https://img.shields.io/badge/Swift-5.5-orange)](https://swift.org)

[![License](https://img.shields.io/github/license/almazrafi/URLQueryCoder)](https://opensource.org/licenses/MIT)

## Requirements

- iOS 12.0+ / macOS 10.14+ / watchOS 5.0+ / tvOS 12.0+

- Xcode 13.0+

- Swift 5.5+

## Usage

```swift

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](http://cocoapods.org) is a dependency manager for Cocoa projects. You can install it with the following command:

``` bash

$ gem install cocoapods

```

To integrate URLQueryCoder into your Xcode project using [CocoaPods](http://cocoapods.org), specify it in your `Podfile`:

``` ruby

platform :ios, '12.0'

use_frameworks!

target '' do

    pod 'URLQueryCoder'

end

```

Finally run the following command:

``` bash

$ pod install

```

### Carthage

[Carthage](https://github.com/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:

``` bash

$ brew update

$ brew install carthage

```

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

``` ogdl

github "almazrafi/URLQueryCoder" ~> 1.1.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](https://swift.org/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`:

``` swift

.package(url: "https://github.com/almazrafi/URLQueryCoder.git", from: "1.1.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

// swift-tools-version:5.5

import PackageDescription

let package = Package(

    name: "MyPackage",

    products: [

        .library(name: "MyPackage", targets: ["MyPackage"])

    ],

    dependencies: [

        .package(url: "https://github.com/almazrafi/URLQueryCoder.git", from: "1.1.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](LICENSE) file for more info.