サイトマップ

サイトマップはmockkit.jsonの sitemap プロパティで定義する配列です。詳しい仕様はmockkit.jsonを参照してください。

ここに定義した情報は、Viewer の左サイドバーでそのサイトの画面を一覧表示する時に使われます。このプロジェクトの目次のようなものですので、プロジェクトの構造が変わった場合はサイトマップを書き換える必要があります。

以下の JSON は mockkit.json 中のサイトマップ部分の例です。

// mockkit.json（説明のため sitemap プロパティ以外を省略したもの）
{
  "sitemap": [
    { "type": "page", "name": "ホーム", "path": "/" },
    {
      "type": "group",
      "name": "非ログイン画面",
      "content": [
        { "type": "page", "name": "商品一覧画面", "path": "/products/" },
        { "type": "page", "name": "商品詳細画面", "path": "/products/0/" }
      ]
    }
  ]
}

サイトマップ項目

項目の種類

サイトマップには以下の2種類の項目（画面の情報）を含めることができます。type プロパティで項目の種類を指定します。

項目タイプ	説明
group	グループ化された項目を定義します。フォルダのようなものです。
page	ページを定義します。ファイルのようなものです。

表示名

その項目の表示名を name プロパティで指定します。

パス

その項目のパスを path プロパティで指定します。

INFO

path プロパティは、type = page の項目にのみ指定できます。

内容

その項目の内容を content プロパティで指定します。

content プロパティは配列で、その中に複数のサイトマップ項目を指定できます。

INFO

content プロパティは、type = group の項目にのみ指定できます。

サイトマップの更新

mockkit dev コマンドや mockkit generate コマンドを実行すると、mockkit.jsonの中のサイトマップ情報が解釈され、ビルド出力先パブリックディレクトリに出力されます。また、mockkit dev コマンドによって開発サーバを起動中の場合は、mockkit.jsonを編集すると自動的に更新が行われます。

これにより Viewer が最新のサイトマップ情報を参照できるようになります。