Swagger und Jason

shazam911

Ensign
Registriert
Nov. 2005
Beiträge
161
Hallo Zusammen,

könnt ihr mit den Unterschiede zwischen bzw. die Zusammenhänge zwischen folgenden Schnittstellen bzw. Dateiformaten erklären:
- Json / Json-Objekt
- Swagger
- Jenkins und
- RabbitMQ

Am besten anhand eines einfachen Beispiels. Ich bin kein Programmieren sondern brauche das zum Verständnis eines Dokuments.

Danke!
 
  • Gefällt mir
Reaktionen: Heinrich Harrer
JSON, kurz fuer JavaScript Object Notation ist ein Datenformat in einem leicht lesbaren Textformat. Dadrinne koennen also Daten gespeichert und uebermittelt werden. Das koennen z. B. Informationen zu einem Nutzer sein, Messdaten usw.
Eine gute Erklaerung findest du acuh auf Wikipedia oder direkt auf der Seite json.org

Bei Swagger handelt es sich um ein Framework, also einer Komponente bei der bei der Entwicklung.
Mit Swagger kann man leicht REST-Schnittstellen entwickeln und Dokumentieren.
REST-Schnittstellen sind, sehr vereinfacht gesagt, eine Ansammlung von Links um bestimmte Daten zusammeln oder um den Server im Hintergrund etwas bestimmtes machen zu lassen. Diese Daten werden als JSON bereitgestellt.

Jenkins ist ein Programm und dient bei der Softwarentwicklung dazu um automatisiert Programme, bzw teile eines Programms zu bauen/kompilieren und anschliessend z. B. auf einem System zu hinterlegen. Besser ist es bei Wikipedia erklaert: https://de.wikipedia.org/wiki/Kontinuierliche_Integration

Bei RabbitMQ kann ich dir leider nicht helfen.
Laut Wikipedia ist es ein Message Broker, was das ist, wird hier erklaert: https://de.wikipedia.org/wiki/Message_Oriented_Middleware

Edit: Wenn du etwas mehr auf den Kontext bzw das Dokument eingesht, koennen wir dir vllt bessere Beispiele bzw Erklaerungen geben.
 
Zuletzt bearbeitet: (Ergaenzung)
Wobei man fairerweise Sagen muss, dass man mit Swagger nicht wirklich eine REST-API programmieren kann.
Man Dokumentiert mit Swagger eine API und kann das Ergebnis der Dokumentation dann eher schlecht als recht in verschiedene Programmiersprachen exportieren. Dabei entsteht dann sozusagen das Skeleton der API, welches dann natürlich noch mit Leben (= Inhalte, Programmierlogik, Abhängigkeiten, usw.) gefüllt werden muss.

Wenn man mit Swagger anfängt eine API zu entwerfen (Design-Phase), dann kann man das so benutzen. Zu einer API-Entwicklung gehört aber noch definitiv mehr als nur Swagger ;)
In der Regel benutzt man Swagger eher zum nachträglichen Dokumentieren seiner API.

Wichtig dabei: Eine API ist nur so gut, wie ihre Dokumentation. Ist die Doku schlecht, taugt die ganze API nichts, weil man sie im Zweifelsfall nicht oder nicht richtig benutzen kann.

PS: Weil ich Swagger 1. selbst bnenutze und 2. es selber schon von einem Externen erlebt habe: Man kann in Swagger auch gut aber auch sehr schlecht Dokumentieren.
 
Zurück
Oben