Learn how to maintain control as a software architect in the age of coding agents.
🔎 Discover our new training: Architecture in the Context of Agentic Development.
socreatory training

API Design with OpenAPI

Basics
2 days
12
Seats
German and English
Online and in-person
Available on request

Also available as in-house training

We run this training exclusively for your team, online or on site.
In-house Offerings

Curriculum

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.

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.

Trainers

Thilo Frotscher

Freelance Software Architect

Main Skills

Java Enterprise, APIs (Web) Services and System Integration

More on this topic

APIs – Digital Building Blocks for Modern Business Models

APIs are much more than just technical interfaces—they are strategic building blocks of modern businesses. In this article, Erik Wilde, Thilo Frotscher, and Falk Sippach explain what matters most when it comes to the design, documentation, security, and governance of APIs.

Falk Sippach
Erik Wilde
Thilo Frotscher

In-house Training

You can also book this training as an in-house training course exclusively for your team. Please use the enquiry form for more details.

Enquire now

You may also like

iSAQB® training
Certificate

iSAQB® CPSA-A® API

10
Technology
10
Methodology
10
Communication
Basics
Advanved
2 Days
12
seats
German and English
Online and In-person
from 1,385.00 €
iSAQB® training
Certificate

iSAQB® CPSA-A® WEB

30
Technology
0
Methodology
0
Communication
Basics
Advanved
3 days
12
seats
German and English
Online and In-person
from 2,069.00 €

Frequently Asked Questions

What is the maximum number of participants in a training session?

For most training sessions, we limit the maximum number of participants to 12 per instructor. This allows us to ensure that you receive the best possible guidance.

Are meals provided during in-person training sessions?

Of course, we’ll take care of your meals during our in-person training sessions. We usually provide snacks twice a day and lunch. Drinks are also available.

Where can I find information about the training session I've already booked?

You can find all the information about your training in our socreatory Navigator. Here, in addition to useful links and information, you’ll find the specific location of the training for in-person sessions and the link to the video call for online sessions.

When and how will I receive my certificate of attendance after the training?

If you have attended at least 75% of the sessions, you will receive a certificate of attendance from us. You can download it from our socreatory Navigator a few days after the training.

Why socreatory?

Beyond the expertise of our trainers and our wide range of training courses, we offer even more compelling reasons to train with us.

All the benefits at your fingertips – download our program overview!

Unique Variety

We offer you the most comprehensive training program for software architecture in the German-speaking region – accredited and certified by iSAQB®.

Powerful IT expertise

Our experienced trainers are renowned experts in the industry and have co-developed 80 percent of the module curricula, both in terms of content and teaching methodology.

Hands-on learning experience

We are committed to providing interactive and engaging learning experiences, ensuring all participants can directly apply what they've learned.

Fair pricing model

The total price is reduced for as few as two participants from your company. Furthermore, you benefit from early bird pricing and enhanced planning certainty.

Looking for team training?

Unlock your team's potential with our specialized software architecture courses. We offer a variety of options, from in-depth iSAQB® training to customized workshops tailored precisely to your company's needs. Discover how these training programs can enhance your team's skills, and take advantage of attractive group and package discounts to maximize the value of your investment.