Skip to content

Commit 33bad8a

Browse files
committed
doc: note on exposed dependencies
1 parent 04c1122 commit 33bad8a

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

website/docs/addNewLanguage.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -88,6 +88,15 @@ Then the resulting User Agent is `Algolia for Java (5.0.0); Search (5.0.0); JVM
8888

8989
You can take a look at the Java implementation [here](https://github.com/algolia/api-clients-automation/pull/347).
9090

91+
### Dependencies
92+
93+
You can use any dependency you want to create the client, it can be Json parser or HTTP client, but it's important to never expose those dependencies through the client, meaning:
94+
- a function cannot return an object from a dependency
95+
- a function cannot accept an object from a dependency as a parameter
96+
- and so on
97+
98+
To achieve this you can create interfaces that can be exposed, and wrap the method you want to be exposed, for an HTTP client for example.
99+
91100
### Requesters
92101

93102
> TODO: informations

0 commit comments

Comments
 (0)