2016-06-29 56 views
7

Il mio cliente desidera che crei una specifica per una futura API REST utilizzando Enterprise Architect (SparxSystems). Il deliverable dovrebbe essere un testo ben formattato (può essere html, docx o rtf). Un diagramma di classe dovrebbe dare un'immagine del corpo del messaggio.Creazione di specifiche per API REST in Enterprise Architect

L'unica cosa che ho trovato finora era https://github.com/bayeslife/api-add-in, un plugin per EA per generare RAML e altro. Qualcuno ha un approccio migliore?

+0

È necessario contattare Sander Hoogendoorn. Ha un approccio per la modellazione dei microservizi, inclusa la loro API REST in Enterprise Architect. –

+0

Di solito (beh, sempre) utilizzo il modo API per creare documentazione. Quindi quanto sopra sembra essere l'approccio migliore a meno che tu non voglia fare tutto da solo. –

+0

@ThomasKilian, cosa intendi per "modo dell'API"? –

risposta

0

vi consiglio di usare il servizio postmanerator che generano la documentazione per l'API automaticamente solo salvare le chiamate API di postino in una raccolta e passa questo collettore a questo servizio che genera la documentazione per voi postmanerator link: postmanerator

I spero che la mia risposta sia utile

+0

Grazie, ma il postmanerator non è una soluzione per l'utilizzo dello strumento Enterprise Architect. –

3

La presentazione "Modeling Microservices" di Sander Hoogendoorn contiene alcune diapositive interessanti sulla modellazione di un'API REST in Enterprise Architect. La presentazione è disponibile su slideshare.net. La diapositiva più interessante è la diapositiva # 75. Ecco l'immagine mostrata in quella diapositiva:

Class model of REST service

(Classe nomi degli attributi e sono in olandese Verklaring significa Dichiarazione e Verklaringen significa dichiarazioni Ma il business alla base di questo esempio non è rilevante...)

Sarebbe bello se qualcuno avesse un plugin per Enterprise Architect per convertire questi diagrammi di classe in specifiche Swagger (Open API specs).