Contract Driven Development - API Specifications as Executable Contracts

Topic: Contract-Driven Development with Specmatic by leveraging API Specifications (Ex: OpenAPI, WSDL) as Executable Contracts to reduce time-to-market by allowing teams to build, test and deploy their MicroServices and MicroFrontends independently. Shift-Left the identification of compatibility issues between Components / Services in complex interdependent systems such as those built with MicroServices architecture to reduce / remove the need for Integration Testing.
Conference: API Specifications Conference 2022, SOUTH SAN FRANCISCO, CALIFORNIA, Organised by OpenAPI Initiative #APISPECS2022

Transcript

2. API Specifications as Executable Contracts @harikrishnan83
3. Hari Krishnan Consultant and Coach @harikrishnan83 Cloud Transformation Extreme Programming Agile and Lean
4. Teaser / Quick Demo OpenAPI Specification to API Tests #NO-CODE
5. Context Why Contract Driven Development? #CDD
6. © 2022 All Rights Reserved
7. © 2022 All Rights Reserved
8. © 2022 All Rights Reserved
9. © 2022 All Rights Reserved
10. Shift-Left Identify compatibility issues without integration testing
11. © 2022 All Rights Reserved Are API Specifications sufficient for his?
12. Executable Contacts Enforcing API Specifications
13. © 2022 All Rights Reserved
14. Consumer Side Story Emulating the Provider #SMART-MOCKS
15. Smart Mocks Live Demo
16. © 2022 All Rights Reserved Workflow Tests / Need for Dynamic Mocks • Step 1 - POST /products – Request: {data} – Response: productId • Step 2 - GET /products/{productId} Output of Step 1 = Input of Step 2
17. Anatomy of a Component Test Isolating Components with Smart Mocks
18. © 2022 All Rights Reserved
19. Provider Side Story Contract as Tests #TESTS-FOR-FREE
20. © 2022 All Rights Reserved
21. Tracer Bullet Approach Live Demo
22. Backward Compatibility Contract vs Contract
23. © 2022 All Rights Reserved
24. Contract vs Contract Live Demo
25. © 2022 All Rights Reserved POP-QUIZ Which of these changes are backward compatible? • In Request – Add a mandatory / required field • In Request – Change Optional Nullable field to Optional Non-Nullable • What if I change a schema component that is referenced – in request and response? – at various levels of hierarchy as part of other schema components – across multiple specification files (remote references)
26. Central Contract Repo Are we on the same page? #TREAT-CONTRACT-AS-CODE
27. © 2022 All Rights Reserved
28. © 2022 All Rights Reserved
29. © 2022 All Rights Reserved Contract Versioning Major – Backward Incompatible Change Minor – Backward Compatible Change Patch – Structure Change Only. Example: Extracting common schema to components section
30. © 2022 All Rights Reserved Referring to Contracts in Central Contract Repo
31. Embracing CDD Contract Driven Development and CI Pipelines
32. © 2022 All Rights Reserved
33. © 2022 All Rights Reserved Credits • Team – Naresh Jain @nashjain – Joel Rosario @finalprefix – Hari Krishnan @harikrishnan83 – and thanks to all Specmatic Contributors, Early Adopters • Third party marks and brands are the property of their respective holders
34. Q and A https://specmatic.in/
35. Thank You! @harikrishnan83 https://specmatic.in/