API Design with OpenAPI

-- 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

-- Audience

This course is aimed at software developers who want to create HTTP APIs but have little experience with the design of such interfaces or would like to deepen their existing knowledge. It is also suitable for API representatives from companies who are developing an API style guide, for example, and would like to learn about and discuss possible design alternatives for different aspects of API design.