API Design First in Practise – An Experience Report
- 08 Oct 2024
- Conference
Presentation summary
API Design First requires that all stakeholders adhere to the spec that has been agreed. Come join me in this talk where I share our experience helping team instantly convert API specs into executable contracts to help them independently develop and confidently deploy their components. This approach of using API specs as executable contracts addresses several shortcomings associated with code generation based techniques we had tried in the past. I will also be sharing how we went about iterative API Design to allow for collaborative evolution of features. And mainly avoiding breaking compatibility during API evolution.
Key takeaways:
1. API Specifications to API Tests in seconds – Also generative API coverage report (similar to code coverage, but for APIs) to verify adherence for API implementations
2. API Specifications as API Mocks
3. Backward Compatibility Testing – API Spec vs API Spec
4. Using Linters effectively
5. Extracting common API Specification elements and reusing them
6. Single source of truth for API specifications to promote collaboration between all stakeholders