apidays Paris 2024 - Death By A Thousand API Versions, Stanislav Zmiev, Monite

Death By A Thousand API Versions
Stanislav Zmiev, Tech Lead of Platform Engineering at Monite

apidays Paris 2024 - The Future API Stack for Mass Innovation
December 3 - 5, 2024

------

Check out our conferences at https://www.apidays.global/

Do you want to sponsor or talk at one of our conferences?
https://apidays.typeform.com/to/ILJeAaV8

Learn more on APIscene, the global media made by the community for the community:
https://www.apiscene.io

Explore the API ecosystem with the API Landscape:
https://apilandscape.apiscene.io/

Transcript

1. Death By a Thousand API Versions Stanislav Zmiev Tech Lead of Platform Engineering Monite
2. About me zmievsa@gmail.com t.me/zmievsa github.com/zmievsa twitter.com/zmievsa linkedin.com/in/zmievsa
3. API-First • A buzzword? • A development practice? • A design paradigm? 3
4. API-First 4
5. API-First 5
6. API-First 6
7. It all comes back to Stripe 7 *Note that I am not associated with Stripe and am only using the publicly available information
8. It all comes back to Stripe 8 *Note that I am not associated with Stripe and am only using the publicly available information
9. Let’s make a good API! 9
10. Let’s make a good API! 1 0
11. What about multiple addresses? 1 1
12. What about multiple addresses? 1 2 1. Extend it!
13. What about multiple addresses? 1 3 1. Extend it! 2. Talk to clients!
14. What about multiple addresses? 1 4 1. Extend it! 2. Talk to clients! 3. GraphQL!
15. What about multiple addresses? 1 5 1. Extend it! 2. Talk to clients! 3. GraphQL!
16. What about multiple addresses? 1 6 1. Extend it! 2. Talk to clients! 3. GraphQL! 4. API Versioning
17. Okay, so how do we version? 1 7 1. Only one dimension 1.2.3-beta
18. Okay, so how do we version? 1 8 1. Only one dimension 2. ISO Dates for versions 1.2.3-beta 2022-11-16
19. Okay, so how do we version? 1 9 1. Only one dimension 2. ISO Dates for versions 3. Versions passed through a custom header 1.2.3-beta 2022-11-16 Monite-Version: 2022-11-16
20. Wait, but how do we actually version? 2 0
21. How solutions are categorized 2 1 Isolation of old versions from new bugs Simplicity of implementation and learning Ease of maintenance
22. Solution 0: GraphQL 2 2 Isolation Simplicity Ease of Maintenance
23. Solution 1: Load balancing 2 3 Isolation Simplicity Ease of Maintenance
24. Solution 2: Single-deployment full app duplication 2 4 Isolation Simplicity Ease of Maintenance
25. Solution 3: Single-app route duplication 2 5 Isolation Simplicity Ease of Maintenance
26. Solution 4: Conversion layer 2 6 Isolation Simplicity Ease of Maintenance
27. What else can we do? 2 7 • How do we minimize the burden on our developers? • How do we minimize the burden on our clients? We need a solid compromise
28. What else can we do? 2 8 Isolation of old versions from new bugs Simplicity of implementation and learning Ease of maintenance
29. What else can we do? 2 9 Isolation of old versions from new bugs Simplicity of implementation and learning Ease of maintenance Improved by automated testing
30. What else can we do? 3 0 Isolation of old versions from new bugs Simplicity of implementation and learning Ease of maintenance Improved by automated testing Improved by longer onboarding for new hires
31. What else can we do? 3 1 Isolation of old versions from new bugs Simplicity of implementation and learning Ease of maintenance Improved by automated testing Improved by longer onboarding for new hires Improved by hiring more people
32. Let’s get back to the basics 3 2 Databases have versions Repositories have versions
33. Solution 5: Migration-based versioning 3 3 twitter.com/brandur Isolation Simplicity Ease of Maintenance
34. Solution 5: Migration-based versioning 3 4 Isolation Simplicity Ease of Maintenance
35. Cadwyn Version Changes 3 5
36. Cadwyn versions 3 6
37. Cadwyn is not only about FastAPI! 3 7
38. But is it… 3 8 • Easy to add a bug to an older version?
39. But is it… 3 9 • Easy to add a bug to an older version? • Slow?
40. But is it… 4 0 • Easy to add a bug to an older version? • Slow? • Hard to switch to?
41. Back to conclusion 4 1 - How acceptable is it to introduce a bug into an old version? - How often do you make breaking changes? - How long do you support your versions? Less More Migrate requests and responses like Cadwyn and Stripe Copy single routes and small pieces of business logic Deploy versions separately
42. Questions? 4 2