Quelle: dotnetpro
APIs dokumentieren mit Swagger 17.01.2022, 00:00 Uhr

Erklärungen auf Knopfdruck

Eine API-Dokumentation zu erstellen und zu pflegen ist aufwändig. Swagger hilft dabei.
Die Welt läuft auf Software oder „Why Software Is Eating The World“ [1] – wie ein berühmter Artikel im „Wall Street Journal“ titelt. Diese Aussage ist bereits einige Male erneut aufgegriffen worden [2] und hat über die Jahre nicht an Aktualität verloren. Ganz im Gegenteil scheint sich diese Erkenntnis von Jahr zu Jahr zu verfestigen. Aus nichttechnischer Sicht ist damit klassischerweise die Anwendungssoftware gemeint. Gerade Dienstleistungen sind aber häufig von programmierbaren Schnittstellen, grob als APIs zusammengefasst, abhängig. Über diese lassen sich Daten austauschen, Workflows abbilden und salopp gesagt Geschäfte abwickeln.
Praktisch jede Anwendung und jedes Unternehmen, das etwas auf sich hält, bietet heute ein API als Schnittstelle an. Manchmal dient ein API dazu, beispielsweise automatisiert Informationen mit anderen Anbietern beziehungsweise dem Kunden auszutauschen, und ist daher eher ein Add-on. Manchmal ist ein solches API aber auch Dreh- und Angelpunkt. Zum Beispiel im Plattformgeschäft, wo sich ganze Dienstleistungen ausschließlich um APIs drehen können.

dotnetpro

Sie wollen zukünftig auch von den Vorteilen eines plus-Abos profitieren? Werden Sie jetzt dotnetpro-plus-Kunde
  • 2 Monate Gratis testen
  • Über 4.000 qualifizierte Fachartikel
  • Auf jedem Gerät verfügbar