API Thinking

Transcript

1. API Thinking 2
2. Creating the digital future together. 3 codecentric AG Hoher Wall 15 44137 Dortmund Daniel Kocot Head of API Expierence & Operations Senior Solution Architect AsyncAPI Ambassador +49 151 10 86 70 74
3. Selfie time! 4
4. Differentation from pure integration mindset 5
7. Pure Integration 8 Focus on connectivity Implementation-dri ven approach Limited scope and scalasbility
8. New way of thinking 9
10. New way of thinking 11 Broader strategic vision Emphasises reusability and user experience Scalability and flexibility
11. API first 12
12. API first 13 PRIORITISING APIS WITHIN THE ORGANISATION APIS BECOME A MAIN PART OF THE BUSINESS MODEL OF THE ORGANISATION API FIRST IS NOT A PARADIGM FOR YOUR DEVELOPMENT TEAM!
13. API as a Product API Product 14
14. Definition 15 VALUE PROPOSITION ANALYTICS AND MAYBE SOME KIND OF MONETISATION OWNERSHIP AND LIFECYCLE MANAGEMENT DOCUMENTATION AND DEVELOPER EXPERIENCE
15. Everything we do now is becoming consumer-centric 16
16. But an API is not the panacea 17
17. APIs are not the panacea 18 In some situations they are not the best fit Security Dependencies Complexity
18. Design first 19
19. Design first Principles 20 Planning before coding Collaboration Early Validation Consistency and Standardization
20. API Thinking 21
21. Classical Design Thinking 22 Empathise Define Ideate Prototype Test
22. API Development API Thinking 23 Empathise with stakeholders Data definition API definition API endpoint and backend implementation Test by stakeholders
23. Business & Developer Success As the definite goal 24
24. What does that mean? 25 With the idea of Business or Developer Success, we take the concept of Developer Experience in your organisation to the next level by also including the User Experience of the application that uses an API. Another factor, the Value Experience, refers to the exchange of values that make APIs sustainable and worthwhile for your organisation to invest in their development and maintenance.
25. Empathise with stakeholders 26
26. Who is going to use the API? 27
27. Use Cases Describing why the API is needed and what systems are involved. 28
28. But… 29
29. You are not the consumer! 30
30. Techniques / Methods 31 Persona Empathic conversation Empathy map Extreme user Job shadowing What – How - Why Domain-Driven Design Event Storming Domain Storytelling
31. API Interaction Patterns 32
32. Definition 33 Different API interaction patterns exist to accommodate various use cases, requirements, and preferences of API consumers. These pattern provide different ways for clients to interact with APIs and can be chosen based on factors such as the nature of the application the desidered level of control and flexibility, and the specific goals of the API design
33. Overview 34 Resource / Hypermedia Tunnel Query Event-Based
34. Resource / Hypermedia 35 EXECUTE A SPECIFIED SET OF METHODS ON REMOTE RESOURCES. HTTP, ODATA, GRPC
35. Tunnel 36 CALL A PROCEDURE/COMMAND ON A REMOTE SERVER AS YOU WOULD LOCALLY CALL A FUNCTION IN YOUR PROGRAMMING LANGUAGE SOAP, XML/JSON-RPC,GRPC, ODATA
36. Query 37 FORMULATE A QUERY AGAINST A REMOTE DATASET AS IF THE API WERE A DATABASE (CF. SQL) ODATA, GRAPHQL
37. Event-Based 38 FETCH EVENTS COMING TO AND FROM MESSAGE BROKER AMQP, MQTT, KAFKA, CLOUDEVENTS AS THE UNDERLYING SPECIFICATION
38. 39 Data definition
39. Daily Routine: Searching for data and creating new value for the organisation 40
40. Discovery of Data 41
41. Awareness of Data Products and Data Contracts 42
42. Data what? 43
43. Data Product 44 VALUE DRIVEN OUTPUT USER INTERACTION CROSS-DISCIPLI NARY DEVELOPMENT MONITORING AND MAINTEANCE
44. Data Product – Schematic View 45
45. Data Contract 46 FORMAL AGREEMENT SCHEMA DEFINITION DATA GOVERNANCE INTERFACE SPECIFICATION
46. More Details 47
47. Only data products that add value can lead to equally valuable API products. 48
48. Data Representation 49 XML JSON Schema JSON for Linking Data (JSON-LD) RDF (Resource Description Framework) CBOR (Concise Binary Object Representation)
49. Data minimization Data observability As the declared goals 50
50. API definition 51 openapi: 3.0.3 servers: - url: 'http://localhost:8080' info: version: 1.0.0 title: News API contact: name: Daniel Kocot url: 'http://www.codecentric.de' email: daniel.kocot@codecentric.de license: name: MIT url: 'https://www.tldrelgal.com/mit' description: An API to provide news
51. Specifications 52 - ProtoBuf - GraphQL Schema
52. Challenges within API Design 53 - Long Running Operations - Paging / Filtering - Large Payloads
53. Establishing a design library and guidelines over time As the declared goal 54
54. API endpoint and backend implementatio n 55
55. API Design First 56 This is where we sketch out the API endpoints, data structures, and use cases before we even think about code. The benefit? We get clarity on what our API needs to do and the best way to structure it, saving us time and headaches down the line.
56. API mediation 57 • Architectural layer to manage, protect and enrich an API • Intercepting API traffic • Concept of "outer" APIs • No business logic should be handled within this layers
57. API Type Classification • Platform APIs • Service APIs 58
58. Platform APIs 59 • Use a framework the development team is proficient with • To create a first representation of the data • Transformation is maybe needed
59. 60 Service APIs
60. Transformations 61 • Use Enterprise Integration Patterns • Apache Camel, Spring Integration, Apache Nifi, SaaS Service (e.g. Make), ...
61. Aggregations 62 • Use again a framework the development team is proficient with • To create aggregated or composed representation of data from Platform APIs • These APIs help to create a better experience for the user
62. Generating model classes for clients 63
63. Test by stakeholders 64
64. Based on the description 65
65. Description becomes a contract 66
66. Provide a Postman Collection of the API (product) 67
67. Contract Testing with Portman CLI https:/ /github.com/apideck-libraries/portman 68
68. 69 • Smoke • Load • Stress • Soak Performance Testing with k6
69. API Development API Thinking 70 Empathise with stakeholders Data definition API definition API endpoint and backend implementation Test by stakeholders
70. Delivery to a platform of choice (APIOps) 71
71. API Operations Pipeline 72
72. Q&A 73
73. Reading material and recommendations 74 • https:/ /blog.codecentric.de • codecentric magazine „Der Softwerker“ • IT Spektrum / https:/ /www.sigs.de/autor/daniel.kocot • https:/ /architectural-bytes.ghost.io In case of interest in more posts around API topics, follow me on LinkedIn or contact me.
74. References 75 • Cover Slide: Photo by Anthony Tori on Unsplash
75. codecentric AG | Hochstraße 11 | 42697 Solingen Creating the digital future together. 76 codecentric AG | Hochstraße 11 | 42697 Solingen Creating the digital future together. Thank you!