Вся документация

Здесь собрана полная карта документации SmartMVC. Читать всё сразу не обязательно. Если вы только знакомитесь со SmartMVC, начните с раздела «Начало работы» и двигайтесь по порядку. Если фреймворк уже подключён, переходите прямо к нужной возможности. В следующих разделах материал становится подробнее и помогает во время разработки и поиска причин ошибок.

Начало работы

Узнайте, какие задачи решает SmartMVC, подключите его к приложению и разберитесь, как он участвует в обработке запроса.

1. Знакомство со SmartMVC
   Разберитесь в назначении SmartMVC, его возможностях и связи со Spring MVC.
2. Быстрый старт
   Явно добавьте зависимости приложения и SmartMVC, затем запустите первый метод API без дополнительных настроек для старта.
3. Как SmartMVC обрабатывает запрос
   Проследите путь от получения запроса до ответа и узнайте, где работают отдельные механизмы расширения.

Ключевые возможности

Освойте ответы, исключения, работу со временем и журналирование — то, что напрямую используется в большинстве веб-приложений.

4. Единый формат ответа
   Используйте стабильную оболочку успешного ответа, модель пагинации и правила автоматической упаковки.
5. Исключения и проверка параметров
   Возвращайте бизнес-ошибки, HTTP-ошибки и сведения об ошибках полей в понятном и предсказуемом формате.
6. Дата и время
   Настройте единые правила ввода, вывода, часовых поясов и заполнения недостающих частей даты и времени.
7. Журнал запросов
   Записывайте путь, статус, длительность запроса и исходный контроллер на выбранном уровне журнала.

Аутентификация и авторизация

Начните с общей модели, а затем подключите собственных пользователей, роли, разрешения и обработку токенов.

8. Основы аутентификации и авторизации
   Изучите полную и аннотационную аутентификацию, анонимный доступ и исключённые пути.
9. Собственная аутентификация и текущий пользователь
   Реализуйте обработчик аутентификации и безопасно получайте текущего пользователя и его разрешения в коде приложения.

Полный пример

10. Пример входа и проверки доступа
    Объедините вход, разбор токена, текущего пользователя и проверку доступа к методу API в один законченный сценарий.

Справочники

Обращайтесь к этим страницам, когда нужно уточнить конкретную настройку, тип или метод.

11. Справочник настроек
    Найдите все параметры spring.smart.mvc.*, их значения по умолчанию и рекомендации по применению.
12. Краткий справочник API
    Найдите основные аннотации, модели ответов, типы исключений, интерфейсы аутентификации и API текущего сеанса.