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.

242 views1 Upvote3 Comments

CTO in Software, 2 - 10 employees
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.
Global Chief Cybersecurity Strategist & CISO in Healthcare and Biotech, Self-employed
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
Asset(IT) Security Advisor/Software Developer in Energy and Utilities, 5,001 - 10,000 employees
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 

Content you might like

CTO in Software, 201 - 500 employees
Without a doubt - Technical Debt! It's a ball and chain that creates an ever increasing drag on any organization, stifles innovation, and prevents transformation.
Read More Comments
40.7k views131 Upvotes319 Comments

Limited environment/Infrastructure resources31%

Inability to quickly identify the root cause of CI/CD pipeline failures45%

Lack of standardized CI/CD pipeline templates across the organization53%

Integrating security tools - inefficient security implementation leading to false positives38%

Poor communication across business and product teams/coordination challenges26%

Cost/resource management26%

Implementation of CI/CD into on-going projects and workflows22%

Internal resistance: training issues, culture, etc.14%

Inefficient implementation of CI/CD due to lack of expertise, poor training, etc.19%

Poorly written unit and acceptance testing9%



We are not doing regression testing10%

25% manual, 75% automated50%

50% manual, 50% automated27%

100% manual, 0% automated8%

Don't know2%


1.6k views3 Upvotes2 Comments