Dokumentation

JSDoc

Statische Typisierung in JavaScript mit JSDoc

Von am 22.02.2022

JavaScript und der Mangel von Typen Auf einer sehr abstrakten Ebene ist es das Ziel von allen Computer-programmen mit Daten zu arbeiten; sie zu lesen, verändern und wieder zu speichern oder weiter-zu-geben. Zu diesem Zweck besitzen alle modernen Programmiersprachen das Konzept von Datentypen, also Arten von Daten. Häufige Datentypen beinhalten verschiedene Arten von Zahlen, Wahrheitswerte, […]

swagger_logo2-690x244

REST APIs dokumentieren – Einführung in Swagger

Von am 31.01.2019

Warum benötigen REST-APIs eine Dokumentation? Eine gut gelungene REST-API zeichnet sich durch unterschiedliche Qualitätsmerkmale aus. Hierzu gehören: Konsistenz, einfache Benutzbarkeit und geeignete Abstraktion. Aber auch eine ordentliche Dokumentation darf dabei nicht fehlen. Schließlich soll die API ja auch für andere Entwickler verständlich und benutzbar sein. Bevor man mit der Implementierung einer App beginnt, ist es […]