Spezifikation für REST-API in Enterprise Architect erstellen

Mein Kunde möchte, dass ich mithilfe von Enterprise Architect (SparxSystems) eine Spezifikation für eine zukünftige REST-API erstelle. Das Ergebnis sollte ein gut formatierter Text sein (kann html, docx oder rtf sein). Ein Klassendiagramm sollte ein Bild des Nachrichtentexts geben.Spezifikation für REST-API in Enterprise Architect erstellen

Das einzige, was ich bisher gefunden habe, war https://github.com/bayeslife/api-add-in, ein Plugin für EA RAML und mehr zu generieren. Hat jemand einen besseren Ansatz?

Quelle

2016-06-29 www.admiraalit.nl

Sie sollten Sander Hoogendoorn kontaktieren. Er hat einen Ansatz zur Modellierung von Microservices, einschließlich ihrer REST-API in Enterprise Architect. –

Normalerweise (gut, immer) gehe ich die API-Möglichkeit, um Dokumentation zu erstellen. Das obige scheint also der beste Ansatz zu sein, es sei denn, Sie möchten alles selbst machen. –

@ThomasKilian, Was meinst du mit "der API Weg"? –

Ich empfehle Ihnen postmanerator Service zu verwenden, die Dokumentation für die API generieren automatisch speichern nur die API-Aufrufe in Postbote in einer Sammlung und geben Sie diesen Sammler zu diesem Dienst generiert es die Dokumentation für Sie Link postmanerator: postmanerator

I hoffe, meine Antwort wäre nützlich

Quelle

2016-07-08 13:45:39

Danke, aber Postmanerator ist keine Lösung für die Verwendung des Tools Enterprise Architect. –

Die Präsentation 'Modellierung Microservices' von Sander Hoogendoorn enthält einige interessante Folien über die Modellierung einer REST-API in Enterprise Architect. Die Präsentation ist verfügbar unter slideshare.net. Die interessanteste Folie ist Folie Nr. 75. Hier ist das Bild auf der Folie gezeigt:

(Klasse und Attributnamen sind in der niederländischen Verklaring bedeutet Erklärung und Verklaringen bedeuten Erklärungen Aber das Geschäft hinter diesem Beispiel ist nicht relevant...)

Es wäre schön, wenn jemand ein Plugin für Enterprise Architect hätte, um diese Klassendiagramme in Swagger-Spezifikationen (Open API specs) zu konvertieren.

Quelle

2016-07-14 13:53:16

Spezifikation für REST-API in Enterprise Architect erstellen

Antwort

Verwandte Themen