UML / API：RESTful APIをモデル化する方法

Question

API PlatformとSymfony 3.2（バックエンド）およびIonic 2（フロントエンド）を使用して開発したRESTFul APIのUMLクラス図とユースケース図を作成する必要があります。クラス図を通じてバックエンドAPIの構造を記述する方法。

誰もがアイデアを持っているか、助けになる可能性がある場合は、本当に感謝しています。ありがとうございました！

Answer 1

だから私の問題の解決策は次のすべてのビットでした：

https://www.ibm.com/developerworks/rational/library/design-implement-restful-web-services/：このことから、クラス図で安らかなAPIをモデル化することは困難ですが（基本的にメソッドの集まりであるため）、「リソース」などのクラスを検討し、メソッド（基本的にHTTPメソッド）を追加し、各リソースへのパス。

これも大きな助けになりました。

• https://firstinfinity.wordpress.com/modeling_rest_web_services/

もう1つの（簡単な）方法は、SpiggerをUMLダイアグラムに変換するPikturrなどのツールを使用することでした。

設計用ソフトウェアREST APIs：

• 視覚的パラダイム
• IBM Rational Software Architect

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

Answer 2

Api Platformは、URLでAPIのSwaggerドキュメントを自動的に生成しますhttp://localhost/docs.json。

https://github.com/nrekretep/pikturr のようなツールを使用して、SwaggerドキュメントからUML図を生成できます。