https://github.com/algolia/algoliasearch-client-kotlin

⚡️ A fully-featured and blazing-fast Kotlin/Android API client to interact with Algolia.
https://github.com/algolia/algoliasearch-client-kotlin

algolia algolia-api api-client coroutines kotlin search-engine

Last synced: 13 days ago
JSON representation

⚡️ A fully-featured and blazing-fast Kotlin/Android API client to interact with Algolia.

• Host: GitHub
• URL: https://github.com/algolia/algoliasearch-client-kotlin
• Owner: algolia
• License: mit
• Created: 2018-10-16T11:19:09.000Z (about 6 years ago)
• Default Branch: main
• Last Pushed: 2024-10-29T11:34:48.000Z (about 1 month ago)
• Last Synced: 2024-10-29T13:25:21.045Z (about 1 month ago)
• Topics: algolia, algolia-api, api-client, coroutines, kotlin, search-engine
• Language: Kotlin
• Homepage: https://www.algolia.com/doc/api-client/getting-started/install/kotlin/
• Size: 5.12 MB
• Stars: 59
• Watchers: 58
• Forks: 23
• Open Issues: 14
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-blazingly-fast - algoliasearch-client-kotlin - ⚡️ A fully-featured and blazing-fast Kotlin/Android API client to interact with Algolia. (Kotlin)

README

        


  

    

  

The perfect starting point to integrate Algolia within your Kotlin project


  


    

    

  




  Documentation  •

  Community Forum  •

  Stack Overflow  •

  Report a bug  •

  FAQ  •

  Support



## ✨ Features

- The Kotlin client is compatible with Kotlin `1.6` and higher.

- It is compatible with Kotlin project on the JVM, such as backend and Android applications.

- It relies on the open source Kotlin libraries for seamless integration into Kotlin projects:

    - [Kotlin multiplatform](https://kotlinlang.org/docs/reference/multiplatform.html).

    - [Kotlinx serialization](https://github.com/Kotlin/kotlinx.serialization) for json parsing.

    - [Kotlinx coroutines](https://github.com/Kotlin/kotlinx.coroutines) for asynchronous operations.

    - [Ktor](https://github.com/ktorio/ktor) HTTP client.

- The Kotlin client integrates the actual Algolia documentation in each source file: Request parameters, response fields, methods and concepts; all are documented and link to the corresponding url of the Algolia doc website.

- The client is thread-safe. You can use `SearchClient`, `AnalyticsClient`, and `InsightsClient` in a multithreaded environment.

## 💡 Getting Started

Install the Kotlin client by adding the following dependency to your `gradle.build` file:

  ```gradle

  repositories {

     mavenCentral()

  }

  

  dependencies {

     implementation "com.algolia:algoliasearch-client-kotlin:$version"

  }

  ```

Also, choose and add to your dependencies one of [Ktor http client engines](https://ktor.io/docs/http-client-engines.html).

Alternatively, you can use [algoliasearch-client-kotlin-bom](/client-bom).  

For full documentation, visit the **[Algolia Kotlin API Client](https://www.algolia.com/doc/libraries/kotlin/)**.

## ❓ Troubleshooting

Encountering an issue? Before reaching out to support, we recommend heading to our [FAQ](https://www.algolia.com/doc/api-client/troubleshooting/faq/kotlin/) where you will find answers for the most common issues and gotchas with the client.

## Use the Dockerfile

If you want to contribute to this project without installing all its dependencies, you can use our Docker image. Please check our [dedicated guide](DOCKER_README.md) to learn more.

## 📄 License

The Algolia Kotlin API Client is an open-sourced software licensed under the [MIT license](LICENSE).