メソッドの入力データの正確な構造を描画する良い方法を知っている人はいますか? 私の場合、サーバー アプリケーションの正しい入力データを指定する必要があります。サーバーは、データを含む http ポストを取得します。このデータは非常に複雑な json データ構造であるため、次の開発者が簡単に図面を確認して、http ポストに必要なデータを理解できるように、これを描画したいと考えています。また、HTTP ヘッダー マーク データを必須またはあるとよいものとして描画できるとよいでしょう。
データ フロー図や sth は必要ありません。そのように。私が必要とするのは、サーバーメソッド用の有効なjsonを構築する方法です。
誰かアイデアがある場合は、この質問に答えるかコメントしてください。バズワードのアイデアがあるだけでも、私は自分でググることができます。
データ構造を記述するために、(1) UML クラス図を使用して、多重度と所有権、および「名前付き関連端」を使用することを検討してください。Kirill Fakhroutdinov の例uml-diagrams.org: Online Shoppingおよびuml-diagrams.org: Sentinel HASP Licensing Domainは、図面がどのように見えるかを示しています。
json構造を具体的に説明する必要があるため、 （2） Google：「jsonスキーマ」で他の人が同じ問題にどのようにアプローチしたかを確認してください。
個人的には、UML ダイアグラムを提供することに加えて、(3)単純な型、ネストされた構造、オプションの部分などを含む構造を実際に記述できるTypeScript 定義ファイルを作成することを検討しますjson。さらに、次の開発者はデータ構造の例 (単体テスト) を検証できます。簡単なTypeScriptスクリプトを作成し、それをコンパイルしようとすることにより、定義に対して