https://github.com/nemoengineering/meilisearch-kotlin

An async Kotlin wrapper around Meilisearch API
https://github.com/nemoengineering/meilisearch-kotlin

Last synced: about 1 month ago
JSON representation

An async Kotlin wrapper around Meilisearch API

• Host: GitHub
• URL: https://github.com/nemoengineering/meilisearch-kotlin
• Owner: nemoengineering
• License: mit
• Created: 2022-04-12T11:40:46.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2024-12-01T15:22:28.000Z (6 months ago)
• Last Synced: 2024-12-01T16:29:55.688Z (6 months ago)
• Language: Kotlin
• Homepage:
• Size: 213 KB
• Stars: 5
• Watchers: 1
• Forks: 1
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-meilisearch - Kotlin - A Kotlin wrapper (Integrations / Community Integrations)

README

        
# Meilisearch Kotlin Client

[![](https://jitpack.io/v/nemoengineering/meilisearch-kotlin.svg)](https://jitpack.io/#nemoengineering/meilisearch-kotlin)

[![CD/CI Workflow](https://github.com/nemoengineering/meilisearch-kotlin/actions/workflows/cdci-workflow.yml/badge.svg)](https://github.com/nemoengineering/meilisearch-kotlin/actions/workflows/cdci-workflow.yml)

A Kotlin wrapper around [Meilisearch](https://github.com/meilisearch/meilisearch) REST API. This library uses Ktor

Client and KotlinX Serialization under the hood in order to provide an async typed client for Meilisearch v1.

## Installation

This library is currently available through JitPack.

In order to use the library, add first the JitPack repository to the `repositories` block and then the dependency to

the `dependencies` block:

```kotlin

repositories {

    maven("https://jitpack.io")

}

dependencies {

    implementation("com.github.nemoengineering:meilisearch-kotlin:0.5.0")

}

```

## Usage

In order to interact with the Meilisearch you need to first instantiate a client which can then be used to perform the

operations supported by the API:

```kotlin

val client = Meilisearch {

    port = 7700

    host = "localhost"

    apiKey = "my-api-key" // optional

}

val response: List = client.listIndexes()

```