Puml2openAPI: Unterschied zwischen den Versionen
Zur Navigation springen
Zur Suche springen
(Die Seite wurde neu angelegt: „ == Sichtbarkeit von Elementen == {| class="wikitable" |- ! Prefix !! PUML-Semantik !! Klassendefinition !! ReST-RequestBody !! ReST-Response |- | + || public…“) |
|||
| (2 dazwischenliegende Versionen desselben Benutzers werden nicht angezeigt) | |||
| Zeile 1: | Zeile 1: | ||
| + | |||
| + | Das OwS-Plugin "Puml2openAPI" ermöglicht es, aus einem plantUML Klassendiagramm eine openAPI Spezifikation zu erzeugen. Dieses bietet einen einfachen Weg, um eine objekt- oder ressourcen-orientierte Schnittstelle mitsamt der über diese Schnittstelle verwalteten Objekte zu definieren. Durch das Zielformat openAPI stehen eine Vielzahl weiterer Werkzeuge - z. B. zum Rendern der Schnittstellendokumentaton oder zur Generierung von Beispielnachrichten - zur Verfügung. | ||
| + | |||
| + | = Übersicht = | ||
| + | |||
| + | <p>[[Datei:class OwS_openAPI_Übersicht.png|640px|none]]</p> | ||
| + | <hr> | ||
== Sichtbarkeit von Elementen == | == Sichtbarkeit von Elementen == | ||
| Zeile 4: | Zeile 11: | ||
{| class="wikitable" | {| class="wikitable" | ||
|- | |- | ||
| − | ! Prefix !! PUML-Semantik !! Klassendefinition !! ReST-RequestBody !! ReST-Response | + | ! Prefix !! PUML-Semantik !! Klassendefinition !! ReST-RequestBody !! ReST-Response !! Verwendung |
|- | |- | ||
| − | | + || public|| ja || ja || ja | + | | + || public|| ja || ja || ja || ... |
|- | |- | ||
| − | | # || protected || ja || nein || ja | + | | # || protected || ja || nein || ja || ... |
|- | |- | ||
| − | | - || private|| nein || nein || nein | + | | - || private|| nein || nein || nein || ... |
|- | |- | ||
| − | | ~ || package private|| | + | | ~ || package private|| ja || nein || nein || Beispiel: Ein Dienst verwaltet Dokumente. Verweise auf alte Dokumentenversionen sind Teil der zugrundeliegenden Klasse, werden aber normalerweise weder bei Anfragen noch bei Antworten mitgegeben, sondern können nur explizit abgefragt werden. |
|} | |} | ||
Aktuelle Version vom 16. Mai 2021, 09:24 Uhr
Das OwS-Plugin "Puml2openAPI" ermöglicht es, aus einem plantUML Klassendiagramm eine openAPI Spezifikation zu erzeugen. Dieses bietet einen einfachen Weg, um eine objekt- oder ressourcen-orientierte Schnittstelle mitsamt der über diese Schnittstelle verwalteten Objekte zu definieren. Durch das Zielformat openAPI stehen eine Vielzahl weiterer Werkzeuge - z. B. zum Rendern der Schnittstellendokumentaton oder zur Generierung von Beispielnachrichten - zur Verfügung.
Übersicht
Sichtbarkeit von Elementen
| Prefix | PUML-Semantik | Klassendefinition | ReST-RequestBody | ReST-Response | Verwendung |
|---|---|---|---|---|---|
| + | public | ja | ja | ja | ... |
| # | protected | ja | nein | ja | ... |
| - | private | nein | nein | nein | ... |
| ~ | package private | ja | nein | nein | Beispiel: Ein Dienst verwaltet Dokumente. Verweise auf alte Dokumentenversionen sind Teil der zugrundeliegenden Klasse, werden aber normalerweise weder bei Anfragen noch bei Antworten mitgegeben, sondern können nur explizit abgefragt werden. |
