1. ホーム
  2. rest

[解決済み] UML / API : RESTful APIをモデル化する方法

2022-01-28 16:14:50

質問事項

API Platform と Symfony 3.2(バックエンド)と Ionic 2(フロントエンド)を使って開発した RESTFul API について、UML クラス図とユースケース図を作成する必要があります。 しかし、クラス図を通してバックエンドAPIの構造をどのように記述すればよいのかよくわかりません。

もし、どなたかお分かりになる方、またはお役に立てる方がいらっしゃいましたら、本当に感謝いたします。ありがとうございます。

解決方法は?

つまり、私の問題に対する解決策は、以下のすべてを少しづつ実行することでした。

https://www.ibm.com/developerworks/rational/library/design-implement-restful-web-services/ : このことから、restful apiをクラス図でモデル化するのは難しいが(基本的にメソッドの集まりなので)、"Resources"のようにクラスを考え、メソッド(基本的にHTTPメソッド)と、各リソースへのパスを追加すればよいという結論に達した。

これもすごく助かりました。

もうひとつの(よりシンプルな)方法は、Pikturrのようなツールを使って、SwaggerをUML図に変換することでした。

REST APIを設計するためのソフトウエア :

  • ビジュアルパラダイム
  • IBM Rational Software Architect

お役に立てれば幸いです。