finos / finos/symphony-bdk-java

Document HttpClient usage

Open
#467 1 comment 1 reaction 0 assignees View on GitHub
[type] documentation good first issue
Dominant language
Java
Stars
29
Forks
77
Avg merge
1d 23h
Merged PRs (30d)
3

Description

The BDK proposes a generic [`HttpClient`](https://github.com/finos/symphony-bdk-java/blob/main/symphony-bdk-http/symphony-bdk-http-api/src/main/java/com/symphony/bdk/http/api/HttpClient.java) that allows developers to perform calls to external systems.

The advantage of this `HttpClient` is it relies on the same implementations that are used to perform calls to the Symphony REST APIs.

Also, developers are free to choose between different implementations by simply selecting the right dependency:
```xml

org.finos.symphony.bdk
symphony-bdk-http-jersey2
runtime

org.finos.symphony.bdk
symphony-bdk-http-webclient
runtime

```

## What do we want?

- [ ] create new `http-client.md` in [./docs/](https://github.com/finos/symphony-bdk-java/tree/main/docs) folder
- [ ] reference this file in [`index.md`](https://github.com/finos/symphony-bdk-java/blob/main/docs/index.md)
- [ ] document configuration and usage of the [`HttpClient`](https://javadoc.io/doc/org.finos.symphony.bdk/symphony-bdk-http-api/latest/index.html) interface and its different implementations

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.