API Design mit OpenAPI (Online)
Description
In this two-day training course, you will learn how HTTP APIs are designed and documented with the help of OpenAPI. At the end, you will be able to apply the concepts you have learned in your own projects and design successful HTTP APIs.
One focus of the training is on the use of best practices in the design of the interface and compliance with important quality features such as consistency, comprehensibility and extensibility. Other important topics for API providers are also discussed, such as strategies for versioning APIs, documentation and API design guidelines.
Why API design is important: HTTP APIs have established themselves as one of the most important tools for system integration in recent years. Sooner or later, every developer is faced with the task of implementing such an interface. Since the pure programming effort is manageable, the design of the interface is often neglected in the hectic pace of everyday project work. This then leads to all kinds of unpleasant challenges in the medium term, for example if the interface proves to be difficult to understand or to extend. It is therefore important to think carefully about the API design before implementing an interface. In this training course, you will learn what to look out for.
Agenda
The 2-day training takes place remotely from 09:00-17:00.
- Brief introduction to the world of APIs
- Why is API design important?
- Quality characteristics of APIs
- Consequences of poor API design
- Making APIs understandable for outsiders (endpoints, attributes, errors)
- API specification with OpenAPI and JSON schema
- Typical issues in API design, solution approaches, best practices
- Anti-patterns: What should be avoided in API design?
- Backwards compatibility and breaking changes
- API versioning: strategies and technical implementation options
- Security aspects of API design
- Existing standards & suggestions for API design: OData, JSON:API, JSON-HAL
- API design guidelines from well-known companies
- API Design Reviews
- How do I create a great developer experience for API client developers?
- Thinking outside the box: Asynchronous APIs and AsyncAPI
Your Trainers
Thilo Frotscher
Thilo Frotscher
Java Enterprise, APIs (Web) Services and System Integration
- API Design with OpenAPI
Thilo Frotscher has been working as a freelance software architect and trainer for over twenty years. He is an expert in Java and the topics of system integration, APIs and (web) services. In addition to numerous in-house training courses, Thilo regularly gives talks and workshops at international specialist conferences, training events and user groups. He is a member of the program advisory board of the “API Conference”, betterCode API() and other specialist events. Finally, Thilo is also the author of numerous articles for IT journals, as well as the (co-)author of several books.