web-dev-qa-db-ja.com

EnterpriseArchitectでREST APIの仕様を作成する

私の顧客は、将来の仕様を作成することを望んでいますREST APIは、Enterprise Architect(SparxSystems)を使用します。成果物は、適切にフォーマットされたテキスト(html、docx、またはrtf)である必要があります。クラス図メッセージ本文の画像を提供する必要があります。

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

11

2019/03/18を更新

このプラグインとガイドラインを使用してください: https://sparxsystems.us/home/software/integration-solutions/restapi/

元の回答

現在、エンタープライズアーキテクトを使用してAPIをモデル化しています。このプロジェクトでは、特定の製品を購入するための予算が付与されているユーザーがいます。モデルはまだ完成していませんが、参考としてここに追加します。

EAでは、いくつかのステレオタイプを追加しました:パス、リソース、表現+新しいデータ型ParamQuery。

APIをモデル化するには、新しいクラス図を作成し、ステレオタイプ「アプリケーション」のクラスとしてAPIのルートから開始します。次に、リソースとパスを追加します。リソースごとに、必要なGET、POST、PUTなどの操作を追加します。 QueryParamsがGET操作の文字列で渡される場合は、それらを操作のパラメーターとして追加しますが、タイプQueryParamとして追加します(最初に作成する必要があります)。 POST操作のメッセージ本文には、それが表すクラスタイプのパラメーターを追加します。

次に、リソースで使用される「表現」クラスを追加します。

enter image description here

2
Chris Aelbrecht

SanderHoogendoornによるプレゼンテーション「ModelingMicroservices」には、エンタープライズアーキテクトでのREST APIのモデリングに関する興味深いスライドがいくつか含まれています。プレゼンテーションは slideshare.net で入手できます。最も興味深いスライドはスライド#75です。これがそのスライドに示されている画像です。

Class model of REST service

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

Enterprise Architectがこれらのクラス図をSwagger仕様(Open API仕様)に変換するためのプラグインがあればいいのにと思います。

6

APIのドキュメントを自動的に生成するpostmaneratorサービスを使用して、API呼び出しをpostmanのコレクションに保存し、このコレクターをこのサービスに渡すことをお勧めします。postmaneratorリンク: postmanerator

私の答えがお役に立てば幸いです

0
Alaa M. Tekleh