ドキュメント一覧

SmartMVC のドキュメント全体を見渡せるページです。最初からすべてを読む必要はありません。初めて使う場合は「はじめに」から順に進み、すでに導入している場合は必要な機能へ直接移動してください。後半ほど内容が詳しくなり、実装や問題解決の際に参照しやすい構成になっています。

はじめに

SmartMVC が解決する課題を知り、最初の導入を終え、リクエスト処理のどこで動くのかを理解します。

1. SmartMVC について
   SmartMVC の役割、提供する機能、Spring MVC との関係を説明します。
2. クイックスタート
   アプリに必要な依存関係と SmartMVC を明示的に追加し、起動用の追加設定なしで最初の API を動かします。
3. リクエスト処理の流れ
   リクエストの受信からレスポンスの返却までをたどり、各機能が連携する位置を確認します。

主要機能

多くの Web アプリケーションで直接利用する、レスポンス、例外、日時、ログの機能を学びます。

4. 統一レスポンス
   一貫した成功レスポンス、ページング結果、レスポンスのラップ規則を利用します。
5. 例外と入力値検証
   業務例外、HTTP エラー、フィールド検証エラーを明確で安定した形式で返します。
6. 日付と時刻
   日時の入力、出力、タイムゾーン、不足部分の補完方法を統一します。
7. リクエストログ
   リクエストパス、ステータス、処理時間、Controller の情報を、設定したレベルで記録します。

認証・認可

基本的な認証モデルから始め、独自のユーザー、ロール、権限、トークン処理へ進みます。

8. 認証・認可の概要
   全体認証、アノテーションによる認証、匿名アクセス、除外パスのルールを理解します。
9. 独自認証と現在のユーザー
   認証ハンドラーを実装し、アプリケーションから現在のユーザーと権限を安全に参照します。

実践例

10. ログイン・認可のサンプル
    ログイン、トークンの解析、現在のユーザー、API の権限確認を一つの流れとして実装します。

リファレンス

特定の設定、型、メソッドを確認したいときは、ここからすばやく探せます。

11. 設定リファレンス
    spring.smart.mvc.* の全設定項目、既定値、使い方を確認します。
12. API リファレンス
    主なアノテーション、レスポンスモデル、例外型、認証インターフェース、現在のセッション API を確認します。