kotlin-api-core

Kotlin model library for usage with various mailguru.io APIs.

Report Bug · Request Feature

Table of Contents

1. About The Project
2. Getting Started
   • Prerequisites
   • Installation
3. Contributing
4. License
5. Contact
6. Acknowledgments

About The Project

Kotlin model library for usage with various mailguru.io APIs.

The error and exception model classes are object representations of JSON:API Error objects (though the mapping itself happens at higher level libraries).

(back to top)

Getting Started

Since this is a low-level mode library that is used within our API client library, there isn't much to see here. We don't provide explicit usage documentation for this library; but you may look into the Javadoc in case you are wondering.

Prerequisites

We choose to support the lowest actively supported Java version at the time of writing, that is, Java 11 (this may be subject to change in future major releases). There are no additional dependencies other than Kotlin and some plugins for publishing and documentation (Dokka).

Installation

There are several ways to install this library:

1. Apache Maven

   <dependency>
     <groupId>io.mailguru</groupId>
     <artifactId>api-core</artifactId>
     <version>0.3.0</version>
   </dependency>
   

2. Gradle Groovy DSL

   implementation 'io.mailguru:api-core:0.3.0'
   

3. Gradle Kotlin DSL

   implementation("io.mailguru:api-core:0.3.0")
   

4. Or you may clone the latest develop branch of this repository and publish it to your local maven repository:

   git clone https://github.com/mailguru-io/kotlin-api-core.git
   cd kotlin-api-core
   ./gradlew publishToMavenLocal

   Then, in your target project, import the local lib by one of the methods above. Please make sure that the version you import matches the value given in your local build.gradle and you local maven repository:

   repositories {
     mavenLocal()
     // ...
   }

(back to top)

Contributing

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

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the GNU General Public License v3.0. See LICENSE.md for more information.

(back to top)

Contact

Project Link: https://github.com/mailguru-io/kotlin-api-core

(back to top)

Acknowledgments

• https://github.com/othneildrew/Best-README-Template

(back to top)