Coursework

FZJ-2024-01996

http://join2-wiki.gsi.de/foswiki/pub/Main/Artwork/join2_logo100x88.png Entwicklung einer REST-API mithilfe einer OpenAPI-Spezifikation und der Swagger Tools

Kromm, A. (Corresponding author)FZJ*

2024

Abstract: In größeren Web-Projekten werden häufig mehrere verschiedene APIs (Application Interfaces) verwendet. Eine weitverbreitete Form solcher APIs ist die REST (Representational State Transfer)-API. Da derartige APIs häufig von mehreren Entwicklern erstellt und verwendet werden, ist eine einheitliche und aktuelle Dokumentation wichtig. Auch ist eine standardisierte Testumgebung für eine solche API von großem Vorteil. Hierdurch wird Entwicklern der Einstieg in die Nutzung dieser Schnittstellen erleichtert. Zur Standardisierung von REST-APIs während der Entwicklung gibt es verschiedene Spezifikationen und Tools. Zu den bekanntesten und am häufigsten verwendeten zählen die OpenAPI-Spezifikation und die Swagger-Tools, mit welchen man APIs unter anderem designen, dokumentieren und testen kann. In dieser Seminararbeit wird mithilfe der OpenAPI-Spezifikation und den Swagger-Tools ein Aufbau einer REST-API untersucht. Es werden anhand von Beispielen zwei verschiedene Ansätze der API-Programmierung, der Contract First Approach und der Code First Approach, verdeutlicht. Anschließend werden Einsatzempfehlungen für beide Varianten gegeben.

Note: Course work, FH Aachen, 2024

---

Contributing Institute(s):

1. Zentralbibliothek (ZB)

Research Program(s):

1. 899 - ohne Topic (POF4-899) (POF4-899)

Appears in the scientific report 2024

---