Home

Awesome

The Rick and Morty API Swift Client

Swift implementation to the awesome Rick and Morty API

Swift codecoverage license

<!-- TABLE OF CONTENTS -->

Table of Contents

<!-- INSTALLATION -->

Installation

For instructions how to add a Swift package to your projects look here:

Apple - Adding package dependencies to your app

<!-- USAGE EXAMPLES -->

Usage

Example to get all characters as an array of character struct:

1. Init client:

let rmClient = RMClient()

2. Request array of characters from server

do {
  let characters = try await rmClient.character().getAllCharacters()
} catch (let error) {
  print(error) 
}

For more examples, please refer to the Documentation or visit Test Section

<!-- CONTRIBUTING -->

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

  1. Fork the repo and create your branch from master.
  2. If you've added code that should be tested, add tests.
  3. If you've changed APIs, update the documentation.
  4. Ensure the test suite passes.
  5. Issue that pull request!
<!-- LICENSE -->

License

Distributed under the MIT License. See LICENSE for more information.

<!-- CONTACT -->

Contact

linkedINContact

<!-- ACKNOWLEDGEMENTS -->

Acknowledgements

<!-- MARKDOWN LINKS & IMAGES --> <!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->