Skip to content

docs(java): installation guide APIC-419 #481

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
May 9, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .github/actions/setup/action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -87,12 +87,12 @@ runs:
id: gen-matrix
shell: bash
run: |
if [[ steps.diff.outputs.JS_ALGOLIASEARCH_CHANGED > 0 ]]; then
if [[ ${{ steps.diff.outputs.JS_ALGOLIASEARCH_CHANGED }} > 0 ]]; then
echo "Running algoliasearch: true"
echo "::set-output name=RUN_JS_ALGOLIASEARCH::true"
fi

if [[ steps.diff.outputs.JS_UTILS_CHANGED > 0 ]]; then
if [[ ${{ steps.diff.outputs.JS_UTILS_CHANGED }} > 0 ]]; then
echo "Running JavaScript utils: true"
echo "::set-output name=RUN_JS_UTILS::true"
fi
Expand Down
112 changes: 108 additions & 4 deletions website/docs/api-clients/installation.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,14 @@ import TabItem from '@theme/TabItem';

<Tabs
groupId="language"
defaultValue="js"
defaultValue="javascript"
values={[
{ label: 'JavaScript', value: 'js', },
{ label: 'PHP', value: 'php', }
{ label: 'JavaScript', value: 'javascript', },
{ label: 'PHP', value: 'php', },
{ label: 'Java', value: 'java' }
]
}>
<TabItem value="js">
<TabItem value="javascript">

To get started, you first need to install `algoliasearch` (or any other available API client package). You can find the full list of available packages [here](https://www.npmjs.com/org/experimental-api-clients-automation).

Expand Down Expand Up @@ -153,4 +154,107 @@ $res = $client->getUserTokenProfile('<YOUR_TOKEN>');
```

</TabItem>

<TabItem value="java">

To get started, add the [algoliasearch-core](https://oss.sonatype.org/content/repositories/snapshots/com/algolia/algoliasearch-core/0.0.1-SNAPSHOT/) dependency to your project, either with [Maven](https://maven.apache.org/):
```xml
<repositories>
<repository>
<id>oss.sonatype.org-snapshot</id>
<url>https://oss.sonatype.org/content/repositories/snapshots</url>
<releases>
<enabled>false</enabled>
</releases>
<snapshots>
<enabled>true</enabled>
</snapshots>
</repository>
</repositories>

<dependency>
<groupId>com.algolia</groupId>
<artifactId>algoliasearch-core</artifactId>
<version>0.0.1-SNAPSHOT</version>
</dependency>
```

or [Gradle](https://gradle.org/):
```groovy
repositories() {
maven { url = "https://oss.sonatype.org/content/repositories/snapshots/" }
}

dependencies {
testImplementation 'com.algolia:algoliasearch-core:0.0.1-SNAPSHOT'
}
```

## Using the client

The package is divided into multiples API Clients, you can find the list [here](https://github.com/algolia/algoliasearch-client-java-2/tree/next/algoliasearch-core/src/main/java/com/algolia/api).
To instanciate a client, prepare your credentials and follow this example:

```java
import com.algolia.api.SearchClient;

public class AlgoliaTest {
public static void main(String[] args) {
SearchClient client = new SearchClient("<YOUR_APP_ID>", "<YOUR_API_KEY>");
}
}
```

You can add segments to the `User Agent`:
```java
import com.algolia.utils.UserAgent;

SearchClient client = new SearchClient(
"<YOUR_APP_ID>",
"<YOUR_API_KEY>",
new UserAgent.Segment[] {
new UserAgent.Segment("tracker", "8.0.0")
}
);
```

And also specify a custom `Requester`:
```java
import com.algolia.utils.echo.EchoRequester;

SearchClient client = new SearchClient(
"<YOUR_APP_ID>",
"<YOUR_API_KEY>",
new EchoRequester()
);
```

Or use a completely different client (some clients might require a `region` parameter):
```java
import com.algolia.api.AbtestingClient;

AbtestingClient client = new AbtestingClient("<YOUR_APP_ID>", "<YOUR_API_KEY>", "us");
```

Once the client is setup, you can play with the Algolia API!

```java
import com.algolia.model.search.*;

SearchParamsObject params = new SearchParamsObject();
params.setQuery("your query");

try {
SearchResponse result = client.search(
"the index name",
SearchParams.ofSearchParamsObject(params)
);
System.out.println(result);
} catch (AlgoliaRuntimeException e) {
e.printStackTrace();
}
```

</TabItem>

</Tabs>