2016-06-29 22 views
7

私の顧客は、Enterprise Architect(SparxSystems)を使用して今後のREST APIの仕様を作成したいと考えています。成果物はよくフォーマットされたテキストでなければなりません(html、docx、またはrtf)。クラス図は、メッセージ本文の画像を与える必要があります。Enterprise ArchitectのREST API仕様を作成

私が今までに見つけたのは、https://github.com/bayeslife/api-add-in、EAがRAMLなどを生成するためのプラグインでした。誰かがより良いアプローチをしていますか?

私はあなたがそれはあなたのためのドキュメントを生成し、単にコレクション内の郵便配達でのAPIコールを保存して、このサービスには、このコレクタを渡す自動的にAPIのドキュメントを生成するpostmaneratorサービスを使用することをお勧めします
+0

Sander Hoogendoornにお問い合わせください。彼はEnterprise ArchitectのREST APIを含むマイクロサービスのモデリングのアプローチを持っています。 –

+0

通常(よく、常に)私はAPIを使ってドキュメントを作成します。あなたがすべてを自分でやりたいのでなければ、上の方が最良のアプローチだと思われます。 –

+0

@ThomasKilian、「APIの方法」とはどういう意味ですか? –

答えて

0

postmaneratorリンク: postmanerator

私は私の答えが役に立つと願っています。

+0

ありがとうございますが、postmaneratorはツールEnterprise Architectを使用するためのソリューションではありません。 –

3

Sander Hoogendoornのプレゼンテーション「Modeling Microservices」には、Enterprise ArchitectのREST APIのモデリングに関する興味深いスライドがいくつか含まれています。プレゼンテーションはslideshare.netで利用できます。最も興味深いスライドはスライド75です。ここではそのスライドに示した画像です:

Class model of REST service

(。。。クラスおよび属性名はオランダ語であるVerklaringは宣言とVerklaringenが宣言を意味意味しかし、この例の背後にあるビジネスは関係ありません)

Enterprise Architectがこれらのクラス図をSwagger仕様(Open API仕様)に変換するためのプラグインを誰かが持っているといいでしょう。

関連する問題