API Client Design Across Languages - Part 2 - Making Requests
It’s been a while since my last post (API Client Design Across Languages - Part 1), but life and work have gotten in the way. Regardless, I’m am finally continuing my dive into how API clients can differ in style and usage across languages while still maintaining the same features.
The first post focused on the basic structure of different API clients. In this post I will go into how a client may make requests against the API.
Languages vary in how well supported making HTTP requests is in their core implementations or standard libraries. Almost by definition, languages used on the web generally have easy ways to make HTTP requests. However, there are often dedicated request libraries that can make this simpler or cleaner, and in general I recommend their use unless the language has very clear and clean support.
There are reasons to not want to include a request library in an SDK as every additional dependency added is one that developers using it will have to add as well. Keeping a small dependency graph also makes it easier to maintain updates. But, letting a library do the low-level work is also good for maintenance and security, and often someone looking to use your SDK will already be using a request library.
I’ll show some examples of the choices FreshBooks made for different languages below.
Sane Request Defaults
Both to make it easier for developers to use our SDKs, and to make our own lives easier in supporting them, we set some defaults for HTTP requests.
Timeouts are especially important. If a request takes too long, it may can impact both the user (slowing the response to their customer) and us (if our servers get saturated by slow requests, we stop service our customers). Most HTTP clients have easily set timeouts but often they are not enabled by default.
Setting user-agent strings is also helpful. Including things like the SDK language and version helps FreshBooks figure our SDK usage and what languages are popular with our developers. Of course we let users over-ride the user-agent if desired. It can also help an API support team track down a reported error if the client has a unique user-agent string.
The SDK should try to be as consistent and intuitive as possible, especially if the API itself is a fairly CRUD-heavy RESTful API versus one with more unique behaviours around resources.
Try to make to keep things standardized like resorce pluralization (eg.
Try to keep method signature variables in a similar order. For instance:
clients.get(id, filters) clients.create(data, filters) clients.update(id, data, filters)
invoices.get(id, filters) invoices.create(data) invoices.update(data, id, filters)
The more standard and intuitive the SDK is, the easier it is for developers and the fewer support tickets.
Like last time, I’ll show some examples of how FreshBook’s SDKs are built in a few different languages.
In python we’re using the requests library for simplicity. Requests is widely used (see the Stripe and Auth0 SDKs) so it isn’t too onerous of a requirement. In fact, FreshBooks’ Python SDK is very light on dependencies in general.
You can see where we instantiate a session (to allow for retries), and make the HTTP requests). In the client we can instantiate the shared client code for each different resource.
Usage looks like:
invoice = freshBooksClient.invoices.get(account_id, invoice_id) clients = freshBooksClient.clients.list(account_id) assert clients.organization == "FreshBooks"
Like Python, our Node.js SDK is using a well-known library axios. While it is not quite as ubiquitous as Python’s requests, it is very commonly used. For instance, it is used by Auth0 (if you’re looking for a different example, Shopify makes use of Got). You can find it configured here. The shared client code takes reqeust and response transform functions for each resource to convert the repsonses to objects.
Like Node.js, the PHP ecosystem has quite a number of good HTTP request libraries. Guzzle is perhaps one of the most well known, but there are many other popular libraries out there. Luckily, PHP also has some interface standards around HTTP clients and messages, particularly PSR-7, PSR-17, and PSR-18,
Implementing the FreshBooks SDK to these standards means that we don’t force any particular library on developers. They are free to choose any library that implements those standards.
In our README we provide an example for those who have no particular preference:
Requires a PSR-18 implementation client. If you do not already have a compatible client, you can install one with it.
composer require amcintosh/freshbooks php-http/guzzle7-adapter
Again, here is the configuration, and the resources using shared client code.
Usage looks like:
$invoice = $freshBooksClient->invoices()->get($accountId, $invoiceId); $clients = $freshBooksClient->clients()->list($accountId); echo $clients->clients->organization; // 'FreshBooks'
So there you can see a number of different HTTP client options, and examples of how FreshBooks’ SDKs utilize them.
I hope you found something interesting or useful here and I hope you can catch the next post where I plan to go into request data and response structures.
This was originally posted to the DEV Community