API Experience - A primer

Transcript

1. API Experience – A primer Daniel Kocot, Senior Solution Architect / Head of API Experience & Operations
2. Name: Daniel Kocot Role: Senior Solution Architect / Head of API Experience & Operations Email: Twitter: @dk_1977 LinkedIn: daniel.kocot@codecentric.de https://www.linkedin.com/in/danielkocot/
3. Customers?
4. Good Design?
5. Adoption of API first An API is the first (and often only) interface to users of an application An API comes first — before the implementation An API is described (documented) or self-descriptive
6. API as a (Digital) Product
7. Design Sprint
9. Personas & Use Cases
10. Personas Who is going to use the API?
11. Use Cases Describing why the API is needed and what systems are involved.
12. BUT…​
13. You are not the consumer!
14. API by use case first
15. API Interaction Patterns Tunnel Resource Hypermedia Query Event-Based
16. Data Model
17. Data first
18. Internal vs. External data model Does the existent data model support the required use cases? Is a middleware for the aggregations and/or transformations needed?
19. Master Data Management Adopting the idea of a Data Catalog
20. API Specification
21. OpenAPI / AsyncAPI
22. Other Specifications ProtoBuf GraphQL Schema
23. Focus Rest(ful) APIs
24. Examples for API Design Patterns Long Running Operations Paging / Filtering Large Payloads
25. Goal: Establishing a design library
26. Architecture Discussion
27. API Architecture
28. Solutions Architecture Pattern Using patterns which are well established in the industry…​ But also still evolving But please only adopt them
29. API Architecture is normally not that simple…​
30. Because we will work more and more on the infrastructure level.
31. API Endpoint Implementation
32. API Mediation 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
33. Generating model classes for clients
34. API Backend
35. Services for Backend Systems Use a framework the development team is proficient with To create a first representation of the data Transformation is maybe needed
36. Transformations Use Enterprise Integration Patterns Apache Camel, Spring Integration, Apache Nifi, SaaS Service (e.g. Make), …​
37. Services for Aggregations Use again a framework the development team is proficient with To create aggregated oder composed representation of data from Backend APIs These APIs help to create a better experience for the user
38. Testing
39. Based on the description
40. Description becomes a contract
41. Provide a Postman Collection of the API product
42. Wrap Up https://linktr.ee/danielkocot
43. Q&A
44. Thank you
45. References Photo by on By docsearls - Flickr, CC BY-SA 2.0, Photo by on Photo by on Photo by on Photo by on Photo by on Photo by on Photo by on Photo by on Photo by on Photo by on Blake Wisz Unsplash https://commons.wikimedia.org/w/index.php? curid=1328081 Jean-Philippe Delberghe Unsplash Kelli McClintock Unsplash Faizur Rehman Unsplash Erik Mclean Unsplash Markus Spiske Unsplash John Salvino Unsplash Gautam Lakum Unsplash Fredy Jacob Unsplash Emil Widlund Unsplash Dan Dennis Unsplash