docs: note on exposed dependencies #428
Conversation
millotp
requested review from
eunjae-lee and
shortcuts
and removed request for
a team
✗ The generated branch has been deleted.If the PR has been merged, you can check the generated code on the |
✅ Deploy Preview for api-clients-automation ready!
To edit notification comments on pull requests, go to your Netlify site settings. |
millotp
changed the title
|
Glad to see the netlify bot commenting twice like ours did :D No need to fix it |
website/docs/addNewLanguage.md
Outdated
| @@ -88,6 +88,15 @@ Then the resulting User Agent is `Algolia for Java (5.0.0); Search (5.0.0); JVM | |||
|
|
|||
| You can take a look at the Java implementation [here](https://github.com/algolia/api-clients-automation/pull/347). | |||
|
|
|||
| ### Dependencies | |||
|
|
|||
| 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: | |||
There was a problem hiding this comment.
The reason behind this could be added
website/docs/addNewLanguage.md
Outdated
| - a function cannot accept an object from a dependency as a parameter | ||
| - and so on | ||
|
|
||
| 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. |
There was a problem hiding this comment.
Do we have an example we can link?
There was a problem hiding this comment.
I don't have a good example right now, I need to make that change in the java client
There was a problem hiding this comment.
Then I think it's good to come back here after the change. WDYT?
There was a problem hiding this comment.
I will add the example once I do the change on java yes, but the doc can still exists in the mean time
🧭 What and Why
State that we should not expose dependencies in our client (this is not yet the case for Java)