Software Integration 101

My slides for DevFest Bali 2023

Transcript

1. Software Integration 101 Made Raka Software Engineer @ GovTech Procurement
2. Why this matters? 2 2
3. 3 3
4. How does the integration take part? 4 4
5. 5 5
6. 6 6
7. 7 7
8. Ensuring the integration reliable and secure 8 8
9. 9 9
10. API contract Static-typed and documented Backward Compatible (BC) 10 10
11. API doc - Endpoint 11 11
12. API doc - Object contract (1) Example 12 12
13. API doc - Object contract (2) 13 13
14. API doc - Object contract (3) 14 14
15. API doc - API response example (4) 15 15
16. API doc - API response example (5) 16 16
17. Backward Compatibility (BC) BC is important since most software product will be improved continously to align with business goals while the business never stops 17 17
18. BC - current API contract 18 18
19. BC - new API contract 19 19
20. 20 20
21. BC in inter-service communication(1) 21 21
22. BC - Client is deployed in multiple machine 22 22
23. API doc tooling with Swagger 23 23
24. API contract in Swagger 24 24
25. API contract in Swagger 25 25
26. Code to generate swagger doc 26 26
27. Integration Styles 1. Synchronous Communication (RPC, HTTP call) 2. Asynchronous Communication (Messaging) 27 27
28. Sync communication McDonald food restaurant Source : Tripadvisor 28 28
29. Async communication (1) McDonald self-service 29 29
30. Async communication (2) 30 30
31. Async comm - benefits 1. Good for long-running and heavy process, able to reduce latency 2. Able to control the traffic load, to protect particular systems from being overwhelmed, i.e database, external API 31 31
32. Async - event contract 32 32
33. Event-driven pattern Notification event State changes event Generic event contract 33 33
34. Notification pattern 34 34
35. Generic event contract Adopting client-less principle Avoid custom event contract for particular consumer 35 35
36. State changes pattern 36 36
37. Patterns 1. Error handling 2. Throttle 3. Idempotency 37 37
38. Error handling as API producer (1) 38 38
39. Error handling as API producer (2) Error code Desc 101 Entity couldn't be found 102 Unknown Error 103 Invalid request 401 Coupon is not eligible for the order 39 39
40. Error handling as API consumer 40 40
41. Throttle (or Rate-limit) 41 41
42. Idempotency 42 42
43. Security Infra-level, i.e VPC Application-level, i.e JWT, basic auth, oauth2 etc 43 43
44. Monitoring Error rate (5xx, 4xx) Latency Throughput 44 44
45. Monitoring Tools Centralized logs Instrumentation tools, i.e Datadog, Prometheus 45 45
46. Thanks 46 46