Skip to content
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

Document HttpClient usage #467

Open
3 tasks
thibauult opened this issue Mar 3, 2021 · 1 comment
Open
3 tasks

Document HttpClient usage #467

thibauult opened this issue Mar 3, 2021 · 1 comment
Labels
good first issue Good for newcomers [type] documentation A documentation enhancement or update

Comments

@thibauult
Copy link
Member

The BDK proposes a generic HttpClient 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:

<dependency>
   <groupId>org.finos.symphony.bdk</groupId>
   <artifactId>symphony-bdk-http-jersey2</artifactId>
   <scope>runtime</scope>
</dependency>
<!-- OR -->
<dependency>
   <groupId>org.finos.symphony.bdk</groupId>
   <artifactId>symphony-bdk-http-webclient</artifactId>
   <scope>runtime</scope>
</dependency>

What do we want?

  • create new http-client.md in ./docs/ folder
  • reference this file in index.md
  • document configuration and usage of the HttpClient interface and its different implementations
@thibauult thibauult added good first issue Good for newcomers [type] documentation A documentation enhancement or update labels Mar 3, 2021
@thibauult thibauult added this to the General Backlog milestone Mar 3, 2021
@mcleo-d
Copy link
Member

mcleo-d commented Mar 8, 2021

Thank you @symphony-thibault for your very well articulated good first issue. I have added to This Week at FINOS to help drive engagement from the FINOS Community 🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers [type] documentation A documentation enhancement or update
Projects
None yet
Development

No branches or pull requests

2 participants