https://github.com/brightspace/ksiren

A Siren parsing library written in Kotlin
https://github.com/brightspace/ksiren

Last synced: 5 days ago
JSON representation

A Siren parsing library written in Kotlin

• Host: GitHub
• URL: https://github.com/brightspace/ksiren
• Owner: Brightspace
• License: apache-2.0
• Created: 2017-07-31T14:58:43.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2024-02-13T17:55:43.000Z (9 months ago)
• Last Synced: 2024-04-11T00:43:19.786Z (7 months ago)
• Language: Kotlin
• Size: 296 KB
• Stars: 2
• Watchers: 19
• Forks: 2
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Codeowners: CODEOWNERS

Awesome Lists containing this project

README

        
# KSiren

[ ![Kotlin](https://img.shields.io/badge/Kotlin-1.3.31-blue.svg)](http://kotlinlang.org)

![Build status](https://github.com/Brightspace/ksiren/actions/workflows/ci.yml/badge.svg)

A Kotlin library for parsing responses from Siren API endpoints and building Siren Action requests.

## Quick start

Options for getting started:

* [Download the latest release](../../releases).

* Clone the repo: `git clone https://github.com/Brightspace/ksiren.git`.

* Include the library in your project with gradle:

```

compile 'com.brightspace.ksiren:ksiren:1.1.0'

```

You must import, or create yourself, a JSON parsing plugin; adapters for moshi and gson are available and can be pulled in using one of the following gradle compile commands:

```

compile 'com.brightspace.ksiren:ksiren-moshi-adapter:1.1.0'

compile 'com.brightspace.ksiren:ksiren-gson-adapter:1.1.0'

```

Optionally, you can include, or create, a request building plugin; an adapter for okhttp3 is available:

```

compile 'com.brightspace.ksiren:ksiren-okhttp3-request-builder:1.0.0'

```

## Documentation

See [the wiki](https://github.com/Brightspace/ksiren/wiki).

## Versioning

Ksiren is maintained under [the Semantic Versioning guidelines](http://semver.org/).

## Contributing

Please read through our [contributing guidelines](CONTRIBUTING.md). Included are directions for opening issues, coding standards, and notes on development.