Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/algolia/algoliasearch-client-java
⚡️ A fully-featured and blazing-fast Java API client to interact with Algolia.
https://github.com/algolia/algoliasearch-client-java
algolia algolia-api algolia-search api-client java java-8 search-engine
Last synced: about 11 hours ago
JSON representation
⚡️ A fully-featured and blazing-fast Java API client to interact with Algolia.
- Host: GitHub
- URL: https://github.com/algolia/algoliasearch-client-java
- Owner: algolia
- License: mit
- Created: 2016-07-05T10:16:19.000Z (over 8 years ago)
- Default Branch: main
- Last Pushed: 2024-10-29T11:34:44.000Z (3 months ago)
- Last Synced: 2024-10-29T13:25:16.277Z (3 months ago)
- Topics: algolia, algolia-api, algolia-search, api-client, java, java-8, search-engine
- Language: Java
- Homepage: https://www.algolia.com/doc/api-client/getting-started/install/java/
- Size: 45.5 MB
- Stars: 46
- Watchers: 70
- Forks: 33
- Open Issues: 20
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- awesome-blazingly-fast - algoliasearch-client-java-2 - ⚡️ A fully-featured and blazing-fast Java API client to interact with Algolia. (Java)
README
The perfect starting point to integrate Algolia within your Java project
Documentation •
Community Forum •
Stack Overflow •
Report a bug •
FAQ •
Support
## ✨ Features
* Support Java 8 and above
* Asynchronous and synchronous methods to interact with Algolia's API
* Thread-safe clients
* Typed requests and responses
## 💡 Getting Started
To get started, add the algoliasearch-client-java dependency to your project, either with [Maven](Maven):
```java
com.algolia
algoliasearch
[4,)
```
or [Gradle](https://gradle.org/):
```java
dependencies {
implementation 'com.algolia:algoliasearch:4.+'
}
```
You can now import the Algolia API client in your project and play with it.
```java
import com.algolia.api.SearchClient;
import com.algolia.model.search.*;
SearchClient client = new SearchClient("YOUR_APP_ID", "YOUR_API_KEY");
// Add a new record to your Algolia index
client.saveObject("", Map.of("objectID", "id", "test", "val"));
// Poll the task status to know when it has been indexed
client.waitForTask("", response.getTaskID());
// Fetch search results, with typo tolerance
client.search(
new SearchMethodParams()
.setRequests(List.of(new SearchForHits().setIndexName("").setQuery("").setHitsPerPage(50))),
Hit.class
);
```
For full documentation, visit the **[Algolia Java API Client](https://www.algolia.com/doc/libraries/java/)**.
## ❓ Troubleshooting
Encountering an issue? Before reaching out to support, we recommend heading to our [FAQ](https://www.algolia.com/doc/api-client/troubleshooting/faq/java/) where you will find answers for the most common issues and gotchas with the client. You can also open [a GitHub issue](https://github.com/algolia/api-clients-automation/issues/new?assignees=&labels=&projects=&template=Bug_report.md)
## Contributing
This repository hosts the code of the generated Algolia API client for Java, if you'd like to contribute, head over to the [main repository](https://github.com/algolia/api-clients-automation). You can also find contributing guides on [our documentation website](https://api-clients-automation.netlify.app/docs/introduction).
## 📄 License
The Algolia Java API Client is an open-sourced software licensed under the [MIT license](LICENSE).