Puml2openAPI

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.