Introduction
APIs have become an essential part of Hackney’s digital transformation. They are the building blocks of the majority of our new internal systems and are part of the foundation of our cloud based architecture. They provide the opportunity for reuse and the flexibility to combine data and services in new and previously unimaginable ways.
This API playbook will help readers to understand:
- Why APIs have become so important to our software development process
- How we go about building our APIs
- How we support and maintain our APIs
- Some best practices that we have adopted as standard in our development of APIs
Why a Playbook?#
Some people may wonder why we have decided to establish a playbook. During our journey of digital transformation we were fortunate to work with a number of partners and agencies; We gained a significant amount of knowledge from them and learned to do things in many different ways. With that, however, we realised that the various ways APIs were implemented across our projects meant that there was no consistency. This meant they became a challenge to maintain. We decided that if we had a consistent standard of implementation, it would make it easier for us to maintain services and to help get new developers onboard.
Our Playbook journey#
Over the past few years we have created several iterations of our playbook. These iterations were necessary as we gained clarity on what the best set of tools and practices would be for us as a development team.
We had the opportunity to learn and grow - discovering that we may have got some things wrong or could do with improvements was all part of the journey. For example, during the course of our journey we have transitioned from container based services running on EC2 machines to serverless functions. We also reviewed our API authorisation methods and implemented a custom authorisation solution. We have continued to work with our agency partners to continuously improve our development practices and standards, and the playbook has evolved as a result.
Today we have come to the point where our playbook has taken a more governance role and now leads more than it is led; onboarding has never been so easy. This also allowed us to justify the ROI (Return on Investment) on API strategy by bringing consistency and standardisation across all APIs developed by internal/external developers for relevant services. However, as technology changes and we learn new things, undoubtedly our playbook will continue to evolve.
Who this Playbook is for#
This playbook is primarily used to onboard new developers, whether they are new members of staff or new agency partners we work with. However, we would be thrilled if this playbook is also read by a wider audience. We are also always happy to receive contributions or feedback to make this even better.
Help us improve#
We are always looking at ways we can improve. If you have any ideas or suggestions please share your feedback on our playbook GitHub Repo.