There are a lot of resources regarding designing good APIs. I personally found the talk from Joshua Bloch to be hugely informative, Martin Fowler too has been excellent with his blog, talks and books. Design Patterns by Erich Gamma et al. is also an insightful resource. I mention all this, as I try to distill all their wisdom and mix it with my experience. My work has been mainly building web services, and I am going to use API as a place holder for HTTP API in the context of this blog, but it can also be applicable to any kind of API.
I am going to borrow some of the key points from Jasmin Blanchette's The Little Manual of API Desing about how to approach designing APIs.
Should be easy to learn and memorize.
Everyone of us has or will experience(d) how a good/bad naming convention can effect the ease of working with a certain API. Being consistent is one of the easiest ways to achieve simplicity in design. Reducing redundancy is another one.
I once built something like the following end points for fetching two different kinds of hotels.
api/XHotels/ api/XHotel/ api/search/Y/?method=list api/search/Y/?method=detail
The two are essentially fetching hotels from two different providers, and the reason they have such arbitrary urls is that they were built without realising how are they going to be used. The user shouldn't be bothered to memorize two different patterns of urls for essentially receiving a list in both cases.
Adaptable to change. Over-reliance of design on implementation details makes it difficult to add/remove logic.
All things in software start from understanding the requirements first. In some cases the requirements are straight forward, but more often than not questions need to be asked to achieve precision in arriving at ‘what needs to be done’. The ‘what’ is more nuanced than simply having an end result, ‘what’ will also include ‘how’ as in how simple/how easy/how quick/how secure etc.
Implementation should be adjusted to desired usage, rather than the other way. An intuitive api design can be achieved by first focussing on use cases and then move to implementation.
Focussing only on the implementation might lead to a design that forces the user to depend too much on implementation of the api.
Eg: Writing a function that behaves differently based on the number of arguments being passed. I have myself and seen others making this design choice while writing the interface to an api. Letting the interface be dictated too much by the implementation of the functionality makes the api fragile. Let us say if we have two kinds of customer, Premium and Basic. Now observe the following piece of code.
def create_organisation_profile(**kwargs): if 'registration' in kwargs: model = PremiumUser else: model = BasicUser ...
Making the logic depend on whether the input data contains a particular element, makes the code a poor fit for future additions/removals to types of customers in our application. It is much more efficient to have a extra field passed to function/api to distinguish which logic to execute. Deciding between booleans v/s enums becomes important in this case, depends on whether our use case can have more than two variations or not, i.e. predicting accurately whether there can only be 2 of a kind. A much more durable way of writing the above logic would be the following -
def create_organisation_profile(**kwargs): if kwargs['type'] == PREMIUM: model = PremiumUser elif kwargs['type'] == BASIC: model = BasicUser ...
where more elif conditionals can be added to handle any future customer types.
Separating out code that interacts with different layers of the software as much as possible. For e.g.: DB queries, third party API calls, push notifications etc.
I have found that having the source code separated into different logical layers is extremely helpful in both development and maintenance of the application. In other words following a MVC/MVP/MTV pattern. The aforementioned patters get implemented by starting to create separate files for models, controllers and views. But what gets overlooked or forgotten while development process is to deliberately use this separation to decide where your code should be written. In other words, asking the question - 'Where should this logic stay?' - everytime you write a piece of code. Another thing one can often miss is, to stop after creating these 3 files. A better, more cleaner project structure can be attained by having further more classification of the logic written (or the files created) .
def register_user(request): . . . user = User.objects.create(username=username, email=email, password=password, first_name=first_name, last_name=last_name) email_text = email_text.replace('#FIRST_NAME',user.first_name) notification = Noitification.objects.create(user=user, notification_type=SIGN_UP) notification.send(text=text)
As you can see from above, having all your operational logic within a single function even though being bug proof is a bad idea. One of the key moments of transforming out of a novice developer is not falling into the trap of thinking “what’s wrong with this, it works perfectly”. A more seasoned developer would put it in a slightly different manner - “it works perfectly NOW, BUT what can go wrong”
Another use of having code separation is it enables the code to be DRY, i.e. if we have a method/function that has our authentication logic, we can reuse it without rewriting the code everywhere.
Use design patterns wherever applicable .. makes code more readable and debuggable.
Design patterns are useful tools in approaching a problem. They help us in thinking in terms of reusability, isolation, refactorability etc. On an average day I am usually writing my logic on top of an already well designed framework, which has all the right kind of patterns baked in. But once in a while I encounter a problem, which forces me to customise the out-of-the-box solutions provided. This is when design patterns help. Using them judiciously wherever needed/applicable can immensely improve code readability and maintainability.
Application code is written only once, but read over and over again by different developers over the lifetime of the application. Readable code is easier to document and maintain. It is also less likely to contain bugs, because the bugs are made more visible by the code’s readability. (The Little Manual of API Design)
I think everyone will come across the readability problem at one point or another. But I'd like to emphasize how design patterns can make the code not only more robust but also much more readable and maintainable.
switch statements are inevitable when it comes to implementing business rules. If your business rules are too complex, you might end up with something looking like this -
... if payment.customer in discountedcustomers: # custom flow for premium customers if payment.getpendingamount() > 0: # flow for handling pending payments
else: # usual flow ...
Using a slightly customized Strategy Pattern can help avoid so many possible issues that may arise with the above code.
def getcustomerstrategy(payment): if payment.customer.type == PREMIUM: return processpremiumcustomer return processfreecustomer def getpaymentstrategy(payment): if payment.getpendingamount() > 0: return remindpendingamounts elif payment.getpendingamount() == 0: return processorder
Splitting up the conditionals like this will automatically improve readability just with the mere presence of function names which are descriptive and small enough by themselves to digest the logic.
Find the right balance between generalising and specialising the scope of each aspect of API - when in doubt, leave it out
Joshua Bloch brings talks about this in his talk about API design.
It is advised not to over generalise the API use cases. Bloch uses libraries as an example of APIs in his talk, but this can also be applied to Web Services. Making an endpoint perform too many actions per request can lead to a host of debugging problems.
def post(request): ... createevent(data) createattendeetypes(types) createattendees(attendee_list) ...
A good example is creating parent and child records from the same API call. This leads to failures caused by having too many dependencies and can mess up the state of the application.
Writing testable code.
Lastly testing also plays an important part of designing APIs. A well written test suite can catch design loopholes and bugs early in development process, and more.
- Helps in regression testing after every bug fix, refactor or feature addition.
- Crystallises the requirements - what is the code expected to do?
- Makes you think whether you’ve actually solved the problem.
- Forces you to make better design decisions.
- Gives you a measure of quality and progress.
- Catches bugs early.
- Helps in knowledge transfer.
- Makes your code readable and easy to navigate.
There’s no secret to writing tests .. there are only secrets to writing testable code. - Misko Hevery of Google
Writing testable code is an art. But thankfully writing testable code overlaps with designing good APIs/software.