https://github.com/dingwilson/randomuserswift

👤 Framework to Generate Random Users - An Unofficial Swift SDK for randomuser.me
https://github.com/dingwilson/randomuserswift

api api-wrapper generate ios mock open-source random swift test ui user

Last synced: 17 days ago
JSON representation

👤 Framework to Generate Random Users - An Unofficial Swift SDK for randomuser.me

• Host: GitHub
• URL: https://github.com/dingwilson/randomuserswift
• Owner: dingwilson
• License: mit
• Created: 2016-10-11T15:29:18.000Z (about 8 years ago)
• Default Branch: master
• Last Pushed: 2021-05-28T04:17:17.000Z (over 3 years ago)
• Last Synced: 2024-10-14T03:26:48.771Z (about 1 month ago)
• Topics: api, api-wrapper, generate, ios, mock, open-source, random, swift, test, ui, user
• Language: Swift
• Homepage: https://www.randomuser.me
• Size: 2.69 MB
• Stars: 96
• Watchers: 4
• Forks: 12
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        


  



[![Build Status](https://travis-ci.org/dingwilson/RandomUserSwift.svg?branch=master)](https://travis-ci.org/dingwilson/RandomUserSwift)

[![codecov](https://codecov.io/gh/dingwilson/RandomUserSwift/branch/master/graph/badge.svg)](https://codecov.io/gh/dingwilson/RandomUserSwift)

[![doccov](https://wilsonding.com/RandomUserSwift/badge.svg)](https://wilsonding.com/RandomUserSwift)

[![CocoaPods Version Status](https://img.shields.io/cocoapods/v/RandomUserSwift.svg)](https://cocoapods.org/pods/RandomUserSwift)

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

![Platform](https://img.shields.io/badge/platforms-iOS-333333.svg)

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

[![MIT License](https://img.shields.io/badge/license-MIT-blue.svg)](https://opensource.org/licenses/MIT)



  



RandomUserSwift is an easy to use Swift framework that provides the ability to generate random users and their accompanying data for your Swift applications. It utilizes [randomuser.me](https://www.randomuser.me) API to generate the data.

1. [Integration](#integration)

    - [Cocoapods](#cocoapods)

    - [Carthage](#carthage)

2. [Usage](#usage)

3. [License](#license)

## Integration

#### CocoaPods

You can use [CocoaPods](https://cocoapods.org/) to install `RandomUserSwift` by adding it to your `Podfile`:

```ruby

target 'MyApp' do

	pod 'RandomUserSwift'

end

```

#### Carthage

You can use [Carthage](https://github.com/Carthage/Carthage) to install `RandomUserSwift` by adding it to your `Cartfile`:

```

github "dingwilson/RandomUserSwift"

```

## Usage

Import the framework

```swift

import RandomUserSwift

```

Then, use the `getUsers` function via the `shared` singleton with a completion handler.

```swift

RandomUser.shared.getUsers { data, error in

    guard let data = data else { return }

    print(data)

}

```

For more information on the configuration and returned values, check out the [RandomUserSwift documentation](https://wilsonding.com/RandomUserSwift) or [RandomUser official documentation](https://www.randomuser.me/documentation)

## License

`RandomUserSwift` is released under an [MIT License](https://opensource.org/licenses/MIT). See `LICENSE` for details.

**Copyright © 2016-present Wilson Ding.**

*Please provide attribution, it is greatly appreciated.*