2016-06-29 5 views
7

Мой клиент хочет, чтобы я создал спецификацию для будущего REST API с помощью Enterprise Architect (SparxSystems). Доставляемый текст должен быть хорошо отформатирован (может быть html, docx или rtf). Диаграмма классов должна давать изображение тела сообщения.Создать спецификацию для REST API в Enterprise Architect

Единственное, что я нашел до сих пор, это https://github.com/bayeslife/api-add-in, плагин для EA для создания RAML и многое другое. У кого-то есть лучший подход?

+0

Связаться с Sander Hoogendoorn. У него есть подход к моделированию микросервисов, включая их REST api в Enterprise Architect. –

+0

Обычно (ну, всегда) Я использую API для создания документации. Таким образом, вышеизложенное представляется лучшим подходом, если вы не хотите делать все сами. –

+0

@ThomasKilian, Что вы подразумеваете под «API-интерфейсом»? –

ответ

0

Я рекомендую вам использовать postmanerator сервис, который генерирует документацию API автоматически только сохранить вызовы API в почтальоне в коллекции и передать этот коллектор к этой услуге он генерирует документацию для вас postmanerator ссылки: postmanerator

I надеюсь, что мой ответ будет полезен

+0

Thanks, but postmanerator - не решение для использования инструмента Enterprise Architect. –

3

В презентации «Моделирование микросервисов» Сандера Хоогендорна содержатся некоторые интересные слайды о моделировании REST API в Enterprise Architect. Презентация доступна по адресу slideshare.net. Самый интересный слайд - слайд # 75. Вот картина, показанная на этом слайде:

Class model of REST service

(Class и имена атрибутов на голландском языке Verklaring означает Декларация и Verklaringen означает Declarations Но дело за этого примера не имеет значения...)

Было бы неплохо, если бы у кого-то был бы плагин для Enterprise Architect для преобразования этих диаграмм классов в спецификации Swagger (спецификации Open API).

 Смежные вопросы

  • Нет связанных вопросов^_^