The API (Application Programming Interface) Programme at the Government Digital Service (GDS) is driving forward efforts to improve API standards, maturity, and connectivity across UK government departments and public sector organisations. This work is closely aligned with the six point plan for modern digital government which calls for all public services to adopt a standard set of APIs and events for new services. This work underpins the government’s ambition for more joined-up, secure, and user-centred digital services.
This blog builds on our earlier api-discovery delivered in partnership with Scrumconnect. It sets out our findings and recommendations from the alpha phase, where we tested the assumptions and hypotheses developed during our discovery.
Our approach
Over 12 weeks, a multidisciplinary team from Scrumconnect worked with the GDS API Programme to explore what a centralised API Hub could look like. We carried out user research across departments and developed several proofs of concept (PoCs) based on interviews, surveys and testing. We focused on four key areas:
- API design guidance
- Reference architecture and patterns
- Automated tool to generate GDS style API documentation from OpenAPI specifications
- API hub site to host these resources
What we learnt in the alpha phase:
At the end of the alpha phase, our research confirmed the pain points we’d heard in discovery, namely:
- APIs are difficult to find
- have limited documentation
- with inconsistent adoption of standards
- security and governance were common concerns
We revealed strong support for the concept of a centralised API hub:
- High user interest: Most users were keen on a central space for APIs
- Better efficiency: Users felt a shared API space would reduce duplication of effort and increase innovation
- Content insights: A review of our existing API guidance pages helped us understand which of these were used most and why
- Developer support: Developers thought a central hub would encourage teamwork and reuse of APIs
Key outcomes from the alpha phase
From these findings, we identified key outcomes that will shape the next phase of development:
- Users wanted to be able to find APIs through the hub not just guidance - so easy access to a catalogue of useful APIs is a must
- We need to redesign guidance around clearer tasks and role-based journeys.
- Developer tools are important so that the hub provides practical support and a signed in developer experience should be explored
- A way to give users information on how compliant an API is against our standards should be included
Our current plan for an MVP of the API hub includes:
- a refreshed API catalogue
- with API quality and security scores for each API listed
- tailored task and role based guidance
- a signed in developer portal with practical tools
What’s next: aligning with other data and API products
The next step before we move forward with the API hub is to ensure we are joined up with other products being developed in GDS to create the best experience for users. We are currently actively engaged with teams working on the open data portal data.gov.uk and the shared data platform datamarketplace.gov.uk, both of which contain data APIs. The key question we need to answer is if what we offer should align or diverge for data and API products to help users make the most of them.
We’re developing products for the whole of the public sector and as part of the GDS commitment to working in the open we are asking for input. If you’re a developer, product manager, content designer or anyone interested in improving how APIs are built and shared, we’d love to hear from you.
To get involved in the conversation please join the API Community by emailing api-community@digital.cabinet-office.gov.uk with your name, organisation and job role.
Leave a comment