設計書の出力 HTML版

最終更新日: 2025年6月4日

リポジトリの内容をHTML形式の設計書として出力するツールの使い方を説明します。

リポジトリをHTML形式に変換する

アプリケーションのリポジトリ（設計情報）を HTML 形式のファイルで出力する機能です。Wagby Designer がなくともリポジトリの内容を閲覧できるビューアとして利用できます。

本ツールが出力するHTMLの例を示します。

本ツールはここからダウンロードできます。

ダウンロードした zip ファイルを解凍すると Repo2html-1.0.1.jar というファイルが得られます。これをWagbyインストールフォルダ内の misc フォルダにコピーしてください。

R8 以上の Wagby でご利用できます。

このプログラムは Java 17 以降で動作します。旧版のWagbyをご利用で Java8/11 でお使いの場合も、このツールを実行するときは Java17 以降に切り替えてください。
設計書を出力する前に、ビルド処理を行ってください。直前にビルドされた状態の設計書を出力します。

ビルドを行っていない状態では、設計書は出力されません。また、Designer で一つでも何らかの変更を行うと内部のリポジトリ状態が変更されるため、appschema の読み込みに失敗します。この場合は差分ビルドを行ってから再度、出力を行ってください。

Windows OS 利用時は、ダブルクリックで実行します。プログラムが終了すると misc フォルダに html というフォルダが作成されています。

html フォルダ内にある index.html をブラウザで開いてください。

コマンドプロンプトから次のコマンドで実行することもできます。

java -jar Repo2html-1.0.1.jar

misc以外のフォルダからこのプログラムを実行することもできます。この場合、コマンドライン引数に、対象となるWagbyフォルダを指定してください。

java -jar Repo2html-1.0.1.jar ~/prj/Wagby-9.3.3

標準では html というフォルダに出力します。出力先を指定する場合は、コマンドの第二引数に出力先を指定します。第一引数に ".." と指定すると、第一引数を省略したことと同じ意味になります。次の例は実行フォルダが misc で、出力フォルダを変更した場合です。

java -jar Repo2html-1.0.1.jar .. report_html

次のHTMLドキュメントが自動生成されます。

helpersフォルダ直下にglossary.mdが出力されます。これはMarkdown形式のファイルで、モデル項目の一覧がアルファベット順に出力されたものです。

Wagby認定技術者試験で用いるサンプルアプリケーション「販売管理」に、本ツールを適用して得られた設計情報をダウンロードできます。出力結果のサンプルとしてご確認ください。

本ツールを一度実行後、AIによって式・スクリプトの説明文を用意することができます。説明文を用意したあと、再度、本ツールを実行すると次の効果があります。

実行フォルダ直下に「html」「helpers」「dbml」フォルダが作成されます。これらのフォルダを別の目的で使用しないようにしてください。
式の説明では、式中に含まれるモデルIDや項目IDは、それぞれモデル名日本語、項目のラベル名に置換されます。ただし関数はそのままです。AIとの連携で、式の説明を（読みやすい）日本語説明文に変換できます。
一部、未出力のリポジトリがあります。今後のバージョンアップで、出力されるリポジトリの内容を拡げていきます。

2026年6月4日公開。ログフォーマット変更。モデル項目詳細設定と環境設定の不足分を対応。

2026年5月25日公開。