This document discusses API design collaboration and proposes a solution to common problems that occur when teams design APIs in silos. The proposed solution standardizes API design templates, implements a design gap detector and centralized user management. It also automates the generation of API stubs, test cases and pipelines to enable early validation of API contracts across environments. This facilitates more automated collaboration, reduces delays and production fixes, and makes troubleshooting easier through blameless culture adoption and transparency across the end-to-end process.

1. API DESIGN
COLLABORATION
UCHIT VYAS

2. ABOUT ME
• Technologist @ Heart
• DevSecOps Practitioner
• One of the top 50 DevSecOps
influencer in the world
• Enterprise Solution Architect
• Infrastructure analyst
• Quality engineering enthusiastic
• Technical author and Speaker
• To know more
• Go to www.hellouchit.com

3. PROBLEM STATEMENTS
• Teams are preparing service API contracts in Silos
• Service API contract are verified & Tested in
SIT/UAT phases
• Troubleshooting is cumbersome process to
identify to root cause
• End-to-End (E2E) environment issues

4. RIPPLE EFFECT
• Delay in realize cycles
• More and more production fixes (CRs)
• Loss of trust from
• Customers
• Management / Leadership
• Waste of manpower / bandwidth usage for
troubleshooting

5. SOLUTION APPROACH
• Standardized templates to design Specs
• Design gap detector process
• Centralized user management & RBAC
• Integrated version control system within Service
Contract Design steps
• Auto generated API stubs, Test cases, and
pipelines trigger for verification
• E2E API contract mapping

6. HIGH LEVEL
IMPLEMENTATION

7. Producer
Consumer
Service API
Contract
Service API
Repository
Orchestrator
Engine
Validate
Consumer
changes
against stub
Validate
Producer
changes
against stub
Environments
If all good,
changes are
ready to be
deployed
SERVICE API COLLABORATION WORKFLOW
1
1
2
3
4
4
5
5

8. BENEFITS
• Early detection of API design gaps
• Failed result tells exactly what is causing the break
and which system it is coming from
• More automated collaboration
• Transparent and Automated Service Contract
Verification using auto-stubs and Orchestration
services
• Failed testing result are due to real system error
and not because of the flaky infrastructure
• Blameless culture adoption for E2E process
• Easy troubleshooting

9. CONCLUSION
• Fail fast for more collaboration
• Automated Verification and validations of designs
• Blameless culture adoption for E2E design process

10. CONNECT WITH ME FOR
MORE…
contact@hellouchit.com
www.hellouchit.com

11. THANK YOU