Does your team ever struggle to define use cases for new APIs? Looking for tips on how to get all stakeholders in agreement early on in the API design process.

Question

Answer

Yes, my team sometimes struggles to define use cases for new APIs. This is because there are often multiple stakeholders with different needs and requirements.

Here are a few tips on how to get all stakeholders in agreement early on in the API design process:

Start by understanding the needs of the stakeholders. What are they trying to achieve with the API? What data do they need to access? What are the performance requirements?
Create a use case document that outlines the requirements of the API. This document should be clear and concise, and it should be shared with all stakeholders.
Hold a workshop with the stakeholders to discuss the use case document. This is a chance to get feedback and to make sure that everyone is on the same page.
Iterate on the use case document based on the feedback from the stakeholders. Once everyone is in agreement, the API can be designed and implemented.

Answer

Getting everyone to agree is hard when the design and reasoning are not well defined. Need to tie the reasoning to the business. Use cases that deliver business value are normally tied into the business by using these three buckets:

- Driven by well-formulated business initiatives
- Driven as a result of industry or government changes
- Technical enablers

Answer

Well, as for new cases to model a new API on, my team might initially have hiccups but a deeper understanding of all that the client needs, it becomes a breeze. We usually would have done similar project in the past, hence we just modify accordingly to suit requirements. Where the major challenge comes is when some stakeholder that were initially left out decides to tumble the requirements overnight even after

Does your team ever struggle to define use cases for new APIs? Looking for tips on how to get all stakeholders in agreement early on in the API design process.

Content you might like

If you had a magic wand - what's the #1 daily business challenge you'd eliminate?

What are your most common challenges with CI/CD? (pick all that apply)

At your organization, how much regression testing for new app features is done manually vs. how much is automated?

What is your primary goal in adopting generative AI for software engineering? Are you using it for coding, productivity or something else?

What CRM would you recommend for a not-for-profit organisation with several thousand members / past members? We have a need for paid event management and paid learning management as well. The organisation is based in Australia and is looking for in-timezone support.