{"id":15068735,"url":"https://github.com/honhimw/meilisearch-rest-client","last_synced_at":"2026-03-06T16:03:22.075Z","repository":{"id":215426153,"uuid":"737481872","full_name":"honhimW/meilisearch-rest-client","owner":"honhimW","description":"Reactive meilisearch rest client powered by reactor-netty-http","archived":false,"fork":false,"pushed_at":"2025-05-19T06:48:38.000Z","size":3479,"stargazers_count":2,"open_issues_count":7,"forks_count":0,"subscribers_count":1,"default_branch":"v1.12","last_synced_at":"2025-08-25T17:45:09.236Z","etag":null,"topics":["gson","jackson","java8","meilisearch","project-reactor"],"latest_commit_sha":null,"homepage":"","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/honhimW.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2023-12-31T07:39:48.000Z","updated_at":"2025-02-06T06:42:06.000Z","dependencies_parsed_at":"2025-08-25T17:31:49.097Z","dependency_job_id":"0b5c3811-531b-48b1-816c-6938cf2f0a51","html_url":"https://github.com/honhimW/meilisearch-rest-client","commit_stats":null,"previous_names":["honhimw/meilisearch-rest-client"],"tags_count":15,"template":false,"template_full_name":null,"purl":"pkg:github/honhimW/meilisearch-rest-client","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/honhimW%2Fmeilisearch-rest-client","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/honhimW%2Fmeilisearch-rest-client/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/honhimW%2Fmeilisearch-rest-client/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/honhimW%2Fmeilisearch-rest-client/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/honhimW","download_url":"https://codeload.github.com/honhimW/meilisearch-rest-client/tar.gz/refs/heads/v1.12","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/honhimW%2Fmeilisearch-rest-client/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":30184885,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-06T14:42:24.748Z","status":"ssl_error","status_checked_at":"2026-03-06T14:42:14.925Z","response_time":250,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["gson","jackson","java8","meilisearch","project-reactor"],"created_at":"2024-09-25T01:39:01.091Z","updated_at":"2026-03-06T16:03:22.061Z","avatar_url":"https://github.com/honhimW.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Meilisearch Rest Client\n\n[![License](https://img.shields.io/badge/license-Apache2-blue.svg)](https://github.com/honhimW/meilisearch-rest-client?tab=Apache-2.0-1-ov-file#readme)\n[![Maven](https://img.shields.io/maven-central/v/io.github.honhimw/meilisearch-rest-client)](https://central.sonatype.com/artifact/io.github.honhimw/meilisearch-rest-client)\n[![CI](https://github.com/honhimW/meilisearch-rest-client/actions/workflows/gradle.yml/badge.svg)](https://github.com/honhimW/meilisearch-rest-client/actions)\n[![Codecov](https://img.shields.io/codecov/c/github/honhimw/meilisearch-rest-client)](https://app.codecov.io/github/honhimW/meilisearch-rest-client)\n\n\n---\n\n\u003ch4 align=\"center\"\u003e\n  \u003ca href=\"https://github.com/meilisearch/documentation\"\u003eDoc Repository\u003c/a\u003e |\n  \u003ca href=\"https://www.meilisearch.com/docs\"\u003eDocumentation\u003c/a\u003e\n\u003c/h4\u003e\n\n[Meilisearch](https://github.com/meilisearch/meilisearch) is a lightning-fast search engine that fits effortlessly into\nyour apps, websites, and workflow.\n\n\u003e The goal of this library is to provide a `object-oriented`, `semantic`, `reactive`, and `streamlined`\n\u003e meilisearch-rest-client, supporting reactivity through reactor-netty-http.\n\n### Version\n\nThe version number of this library is named by appending `.X` to the version number in the official documentation.\n\n| Doc's Version | Library's Version |\n|---------------|-------------------|\n| V1.12(latest) | 1.12.X.X          |\n| V1.11         | 1.11.X.X          |\n| V1.10         | 1.10.X.X          |\n| V1.9          | 1.9.X.X           |\n| V1.8          | 1.8.X.X           |\n| V1.7          | 1.7.X.X           |\n| V1.6          | 1.6.X.X           |\n| V1.5          | 1.5.X.X           |\n\n### Dependencies\n\n**By default**, this library depends on libraries as fallows:\n\n- reactor-netty-http(required)\n- jackson(replaceable by providing implementation of `io.github.honhimw.ms.JsonHandler`)\n\n## Installation\n\n```shell\n# build from sources\n$ ./gradlew clean build -x test\n# publish to maven local\n$ ./gradlew publishToMavenLocal\n```\n\n```groovy\n// Gradle\nimplementation 'io.github.honhimw:meilisearch-rest-client:1.12.0.0'\n```\n\n```xml\n\u003c!-- Maven --\u003e\n\u003cdependency\u003e\n    \u003cgroupId\u003eio.github.honhimw\u003c/groupId\u003e\n    \u003cartifactId\u003emeilisearch-rest-client\u003c/artifactId\u003e\n    \u003cversion\u003e1.12.0.0\u003c/version\u003e\n\u003c/dependency\u003e\n```\n\n**[Copy Snippets here.](https://central.sonatype.com/artifact/io.github.honhimw/meilisearch-rest-client)**\n\n---\n\n## Run Tests\n\n```shell\n$ ./gradlew test\n```\n\nCreate file named `profile-test.properties` under project root directory.\n\n```properties\n./meilisearch-rest-client\n└── profile-test.properties\nmeili-search.host=127.0.0.1\nmeili-search.port=7700\nmeili-search.api-key=MASTER_KEY\n```\n\n**Note**: You may also set `profiles.active` in gradle.properties for loading different properties file such as:\n\u003e profile-alpha.properties: by setting profiles.active=alpha  \n\u003e profile-beta.properties: by setting profiles.active=beta\n---\n\n## Usage\n\n### Searching\n\n```java\npublic static void reactive() {\n    JsonHandler jsonHandler = new JacksonJsonHandler();\n    @Cleanup\n    ReactiveMSearchClient client = ReactiveMSearchClient.create(builder -\u003e builder\n        .enableSSL(false)                    // true: https, false: http\n        .host(\"{{meilisearch-server-host}}\") // server host\n        .port(7700)                          // server port\n        .jsonHandler(jsonHandler)\n        .httpClient(ReactiveHttpUtils.getInstance(http -\u003e http.readTimeout(Duration.ofMillis(100)))));\n    String indexUid = \"movies\";\n    Mono\u003cSearchResponse\u003cMovie\u003e\u003e searchResponse = client.indexes(indexes -\u003e indexes\n        .search(indexUid, search -\u003e search\n            .find(\"hello world\", Movie.class)));\n    List\u003cMovie\u003e hits = searchResponse.block().getHits();\n    // or\n    List\u003cMovie\u003e hits2 = client.indexes(indexes -\u003e indexes\n        .search(indexUid, Movie.class, search -\u003e search\n            .find(q -\u003e q\n                .q(\"hello world\")\n                .limit(1)\n            )\n            .map(SearchResponse::getHits)\n        )\n    ).block();\n}\n\npublic static void blocking() {\n    JsonHandler jsonHandler = new JacksonJsonHandler();\n    @Cleanup\n    MSearchClient client = MSearchClient.create(builder -\u003e builder\n        .enableSSL(false)                    // true: https, false: http\n        .host(\"{{meilisearch-server-host}}\") // server host\n        .port(7700)                          // server port\n        .jsonHandler(jsonHandler)\n        .httpClient(ReactiveHttpUtils.getInstance(http -\u003e http.readTimeout(Duration.ofMillis(100)))));\n    String indexUid = \"movies\";\n    SearchResponse\u003cMovie\u003e searchResponse = client.indexes(indexes -\u003e indexes\n        .search(indexUid, search -\u003e search\n            .find(\"hello world\", Movie.class)));\n    List\u003cMovie\u003e hits = searchResponse.getHits();\n    // or\n    List\u003cMovie\u003e hits2 = client.indexes(indexes -\u003e indexes\n        .search(indexUid, Movie.class, search -\u003e search\n            .find(q -\u003e q\n                .q(\"hello world\")\n                .limit(1)\n            )\n            .getHits()\n        )\n    );\n}\n```\n\n### Search With Details API\n\n```java\npublic static void reactive() {\n    ReactiveTypedDetailsSearch\u003cMovie\u003e searcher = client.indexes().searchWithDetails(\"movies\", Movie.class);\n    searcher.find(builder -\u003e builder\n            .q(\"hello world\")\n            .filter(\"id \u003c 10\")\n            .showRankingScore(true)\n        )\n        .map(response -\u003e {\n            Integer estimatedTotalHits = response.getEstimatedTotalHits();\n            Long processingTimeMs = response.getProcessingTimeMs();\n            return response.getHits();\n        })\n        .doOnNext(hitDetails -\u003e {\n            for (HitDetails\u003cMovie\u003e hitDetail : hitDetails) {\n                SearchDetails details = hitDetail.getDetails(); // Search Details\n                Movie source = hitDetail.getSource();           // Source Document\n\n                Map\u003cString, Object\u003e formatted = details.get_formatted();\n                SearchDetails.Geo geo = details.get_geo();\n                Double rankingScore = details.get_rankingScore();\n            }\n        })\n        .subscribe()\n}\n\npublic static void blocking() {\n    TypedDetailsSearch\u003cMovie\u003e searcher = client.indexes().searchWithDetails(\"movies\", Movie.class);\n    SearchDetailsResponse\u003cMovie\u003e response = searcher.find(builder -\u003e builder\n        .q(\"hello world\")\n        .filter(\"id \u003c 10\")\n        .showRankingScore(true)\n    );\n    Integer estimatedTotalHits = response.getEstimatedTotalHits();\n    Long processingTimeMs = response.getProcessingTimeMs();\n    List\u003cHitDetails\u003cMovie\u003e\u003e hitDetails = response.getHits();\n    for (HitDetails\u003cMovie\u003e hitDetail : hitDetails) {\n        SearchDetails details = hitDetail.getDetails(); // Search Details\n        Movie source = hitDetail.getSource();           // Source Document\n\n        Map\u003cString, Object\u003e formatted = details.get_formatted();\n        SearchDetails.Geo geo = details.get_geo();\n        Double rankingScore = details.get_rankingScore();\n    }\n}\n```\n\n### Await On TaskInfo, Only in blocking\n\n```java\npublic static void blocking() {\n    TaskInfo saveTask = client.indexes(indexes -\u003e indexes\n        .documents(\"movies\").save(jsonQuote(\"{'id':100}\")));\n    TaskView taskView = saveTask.await();\n    TaskStatus status = taskView.getStatus();\n    assert status == TaskStatus.SUCCEEDED || status == TaskStatus.FAILED;\n}\n```","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhonhimw%2Fmeilisearch-rest-client","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhonhimw%2Fmeilisearch-rest-client","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhonhimw%2Fmeilisearch-rest-client/lists"}