Забудьте про application.properties с хардкодом пароля. Подключение PostgreSQL к Spring Boot — это не только JDBC URL, но и пулы соединений, миграции схемы, мониторинг и graceful shutdown в production.
🧩 Вместо того чтобы копировать конфиг из StackOverflow, вы настраиваете полноценный слой персистентности: HikariCP для connection pooling, Flyway/Liquibase для версионирования схемы, Spring Data JPA для репозиториев, и health checks для Kubernetes.
📝 Промпт:
Generate a production-ready Spring Boot 3 + PostgreSQL integration with enterprise-grade configuration:
— Configure PostgreSQL datasource with HikariCP connection pool: pool size optimization, connection timeout, leak detection, and connection validation query.
— Set up Spring Data JPA with Hibernate: dialect configuration, DDL auto strategy, batch processing, second-level cache (EhCache/Redis).
— Implement database migration strategy using Flyway: versioned migrations, repeatable scripts, baseline configuration, and rollback procedures.
— Configure multiple datasources (primary + read replicas) with @Primary and @Qualifier annotations for load distribution.
— Add connection pool monitoring with Micrometer metrics: active connections, idle connections, pending threads, connection acquisition time.
— Implement database health checks for Spring Boot Actuator: connection validation, query timeout, custom health indicators.
— Configure transaction management: isolation levels, propagation strategies, read-only optimization, and timeout configuration.
— Set up connection pool resilience: retry logic with exponential backoff, circuit breaker pattern (Resilience4j), and fallback strategies.
— Add database credentials management: Spring Cloud Config integration, HashiCorp Vault support, or AWS Secrets Manager.
— Configure SSL/TLS connection with certificate validation for secure database communication.
— Implement audit logging: track query execution time, slow query detection, connection pool exhaustion alerts.
— Add database-specific optimizations: fetch size tuning, batch insert/update configuration, native query hints.
— Provide Docker Compose setup with PostgreSQL 16, pgAdmin, and application container with proper networking.
— Include integration tests with Testcontainers: schema validation, repository testing, transaction rollback verification.
— Add example entities with proper JPA annotations: @Entity, @Table, indexes, constraints, relationships (OneToMany, ManyToMany).
— Configure application profiles: dev (H2 in-memory), staging (PostgreSQL), prod (PostgreSQL with replication).
Deliverables:
— application.yml with environment-specific profiles
— build.gradle/pom.xml with all dependencies
— DbConfig.java with datasource and JPA configuration
— V1__init_schema.sql Flyway migration
— Sample entity, repository, and service layer
— Integration test with Testcontainers
— docker-compose.yml for local development
— README with connection troubleshooting guide
— добавьте pgvector для векторного поиска;
— настройте connection pool dashboard в Grafana: throughput, latency percentiles (p50/p95/p99), error rate;
— реализуйте database sharding для горизонтального масштабирования;
— интегрируйте pg_stat_statements для анализа медленных запросов в runtime.
#Enterprise
Please open Telegram to view this post
VIEW IN TELEGRAM
🔥6👍3❤1💯1
Нужно выделить метод целиком? Или весь блок try-catch? Или параметры метода? Обычно хватаешься за мышку и начинаешь аккуратно тащить курсор, рискуя промазать. А потом выделяешь заново, потому что захватил лишнюю скобку. Но можно лучше.
🔹 Что делает
— Умно расширяет выделение от курсора по синтаксическим границам кода
— Понимает структуру Java: слово → выражение → statement → блок → метод → класс
— Работает в обратную сторону: сужает выделение обратно по тем же границам
— Учитывает контекст: для строк расширяет от слова до всей строки, для вызовов — от аргумента до всего вызова
🔹 Зачем это нужно
— Выделяете нужный фрагмент за 2-3 нажатия вместо возни с мышкой
— Безошибочно выделяете сложные конструкции: цепочки вызовов, лямбды, generic-типы
— Идеально для последующего Extract Method, Copy-Paste, или Delete
— Особенно мощно для вложенных структур: легко выделить внутренний if в try внутри цикла
— Ускоряет рефакторинг: выделил логичный кусок → Extract → готово
🔹 Как использовать
— Поставьте курсор внутри нужного фрагмента (на переменную, в середину выражения, в метод)
— Нажмите Ctrl+W (Windows/Linux) или ⌥+Up (macOS) — выделение расширится на уровень выше
— Нажимайте повторно, чтобы расширять дальше: переменная → выражение → строка → if-блок → метод → класс
— Для сужения обратно: Ctrl+Shift+W (Windows/Linux) или ⌥+Down (macOS)
#Enterprise
Please open Telegram to view this post
VIEW IN TELEGRAM
👍11🔥4❤2
Вместо того чтобы копировать чужие сниппеты с StackOverflow, вы настраиваете полноценный слой персистентности через промпт.
Соединения через MongoDB Java Driver, Spring Data MongoDB для репозиториев, audit-логирование, транзакции для replica set, валидацию схемы, health checks, и observability через Micrometer.
📝 Промпт:
Generate a production-ready Spring Boot 3 + MongoDB integration with enterprise-grade configuration:
— Configure MongoDB connection using MongoClientSettings: connection pool size, max idle time, socket timeout, server selection timeout, heartbeat frequency, and SSL/TLS.
— Set up Spring Data MongoDB repositories: custom converters, projection interfaces, pagination, aggregation pipelines, and @Document annotations with proper indexes.
— Implement schema validation using JSON Schema or validator expressions: required fields, enums, type constraints, and validation actions.
— Configure replica set / sharded cluster connectivity: read preference, write concern, journal mode, retryWrites, maxStalenessSeconds, tag sets for multi-region deployments.
— Add connection pooling monitoring with Micrometer: pool sizes, checkout time, wait queues, timeouts, and heartbeat metrics.
— Implement MongoDB health checks with Spring Boot Actuator: ping validation, replica set status check, custom health indicators for stale secondaries.
— Configure transaction management for replica set: multi-document transactions, timeout settings, retryable writes, and error classification for transient transaction errors.
— Set up resilience patterns with Resilience4j: retries with exponential backoff, timeouts, circuit breaker for degraded nodes, fallback strategies for reads.
— Add credentials management: environment variables, Spring Cloud Config, HashiCorp Vault, AWS Secrets Manager, Kubernetes Secrets.
— Configure SSL/TLS: CA certificates, mutual TLS support, certificate revocation checks, hostname verification.
— Implement audit logging: operation time, slow operations, connection churn alerts, replicated writes latency.
— Add MongoDB-specific performance optimizations: index hints, collation settings, fetch size for cursors, batch inserts/updates, compression algorithms (Snappy/Zstd).
— Provide Docker Compose with MongoDB 7.x replica set initialization + Mongo Express UI + Spring Boot container with proper networking.
— Include integration tests using Testcontainers: replica set mode, transaction testing, TTL index validation.
— Add sample @Document entities with indexes: TTL, unique, sparse, compound indexes.
— Configure application.yml profiles: dev (single-node MongoDB), staging (replica set), prod (replica set with sharded cluster).
— Include aggregation examples: $lookup, $facet, $project, $graphLookup, and pipeline-based projections.
— Add encryption-at-rest & field-level encryption (CSFLE) configuration.
Deliverables:
— application.yml with environment-specific profiles
— build.gradle/pom.xml with MongoDB and Spring Data dependencies
— MongoConfig.java with custom MongoClientSettings
— JSON Schema validation file for collections
— Example @Document, repository, and service layer
— Integration tests with Testcontainers (replica set)
— docker-compose.yml with MongoDB replica set + Mongo Express
— README with connection troubleshooting and performance tuning
— настроить Change Streams для real-time событий;
— включить Queryable Encryption;
— реализовать sharding: range/hash sharding, balancer tuning;
#Enterprise
Please open Telegram to view this post
VIEW IN TELEGRAM
👍4❤1🔥1
Нужно переименовать пять переменных одновременно? Или добавить .orElseThrow() к каждому Optional в цепочке? Обычно копируешь первую строчку, вставляешь, правишь, повторяешь еще четыре раза.
Скучно, медленно, и легко ошибиться. А можно умнее.
🔹 Что делает
— Создает несколько курсоров в разных местах кода одновременно
— Все изменения применяются параллельно: печатаешь один раз → меняется везде
— Работает с выделением: можно выделить несколько фрагментов и редактировать их синхронно
— Понимает контекст: может выбрать все вхождения переменной или строки в файле
🔹 Зачем это нужно
— Массовые однотипные правки за секунды вместо копипасты
— Видишь все изменения сразу, до применения
— Идеально для инициализации билдеров: добавляешь .with перед каждым полем одним движением
— Работает с вертикальными блоками кода: легко править список параметров или цепочку вызовов
🔹 Как использовать
— Способ 1: Alt+J (Windows/Linux) или ⌃+G (macOS) — выделяет следующее вхождение слова под курсором.
Нажимайте повторно, чтобы добавить еще вхождения, или Ctrl+Alt+Shift+J / ⌃+⌘+G для всех сразу
— Способ 2: Alt+Shift+Click (Windows/Linux) или ⌥+Shift+Click (macOS) — ставит курсор в место клика.
Кликайте в нужные места, создавая множество курсоров вручную
— Способ 3: Alt+Shift+Insert (Windows/Linux) или ⌘+Shift+8 (macOS) — Column Selection Mode для вертикального выделения.
Для отмены всех курсоров кроме основного: Esc
#Enterprise
Please open Telegram to view this post
VIEW IN TELEGRAM
🔥12❤6👍4
🔥 Как настроить Liquibase для управления миграциями БД
Liquibase — это инструмент для версионирования схемы базы данных. Забудьте про ручные SQL-скрипты и проблемы с синхронизацией между окружениями.
Работает декларативно, отслеживает все изменения, поддерживает rollback и работает с любыми реляционными БД.
1️⃣ Добавляем зависимости
Нужна одна основная зависимость: liquibase-core. Если используете Spring Boot, добавьте spring-boot-starter-liquibase — он автоматически интегрируется с DataSource и запускается при старте приложения.
Критически важно добавить JDBC-драйвер вашей БД (postgresql, mysql-connector и т.д.). Без него Liquibase не сможет подключиться и применить миграции.
2️⃣ Создаём структуру changelog-файлов
Создайте директорию resources/db/changelog/. В корне положите главный файл db.changelog-master.yaml — это точка входа, которая включает все остальные миграции.
В мастер-файле перечисляете пути к конкретным changeset-файлам в порядке применения. Называйте файлы по схеме: v1.0-create-users-table.yaml, v1.1-add-email-column.yaml — так проще ориентироваться в истории изменений.
3️⃣ Настраиваем application.yml
В конфигурации укажите путь к мастер-файлу через параметр spring.liquibase.change-log. По умолчанию это classpath:db/changelog/db.changelog-master.yaml.
Обязательно настройте параметры enabled (включить/выключить), drop-first (очистка БД перед стартом — только для dev!) и contexts (для разделения миграций по окружениям: dev, test, prod).
4️⃣ Пишем changeset'ы
Каждое изменение оборачивается в changeset с уникальным id и автором. Liquibase отслеживает, какие changeset'ы уже применены через служебную таблицу databasechangelog.
Основные типы изменений:
▪️ createTable / dropTable — создание/удаление таблиц
▪️ addColumn / dropColumn — добавление/удаление колонок
▪️ createIndex — создание индексов для оптимизации запросов
▪️ addForeignKey — настройка связей между таблицами
▪️ insert / update — заполнение справочников и тестовых данных
▪️ sql / sqlFile — для сложных кастомных запросов
Используйте preconditions для проверки условий перед применением: например, не создавать таблицу, если она уже существует.
5️⃣ Настраиваем rollback
Liquibase умеет откатывать изменения. Для большинства операций rollback генерируется автоматически, но для sql и sqlFile нужно явно указывать rollback-блок.
Добавляйте тег rollback с SQL-командами отката. Для createTable это будет dropTable, для addColumn — dropColumn. Это критически важно для production — без rollback вы не сможете откатить проблемную миграцию.
6️⃣ Работа с разными окружениями
Используйте contexts и labels для разделения миграций. Тестовые данные помечайте context="dev", production-миграции — context="prod". При запуске приложения указывайте нужный context в конфигурации.
Можно создать отдельные файлы для каждого окружения: db.changelog-dev.yaml с тестовыми данными и db.changelog-prod.yaml только со структурными изменениями. Подключайте их условно через профили Spring.
7️⃣ Лучшие практики
▪️ Никогда не изменяйте уже применённые changeset'ы — создавайте новые для исправлений
▪️ Один changeset = одно атомарное изменение. Не пихайте всё в один файл
▪️ Используйте runOnChange="false" чтобы changeset применялся только один раз
▪️ Добавляйте failOnError="true" для критичных миграций
▪️ Тестируйте миграции на копии production БД перед деплоем
✔️ Что происходит под капотом
При старте приложения Liquibase подключается к БД и проверяет наличие служебных таблиц DATABASECHANGELOG и DATABASECHANGELOGLOCK. Если их нет — создаёт.
Затем читает master-файл, получает список всех changeset'ов и сверяет с таблицей DATABASECHANGELOG. Новые changeset'ы применяются последовательно, информация о них записывается в таблицу с MD5-хэшем для контроля целостности.
💡 Бонус-совет
Интегрируйте Liquibase с CI/CD. Перед деплоем запускайте команду liquibase validate для проверки корректности changelog'ов. В pipeline добавьте команду liquibase updateSQL чтобы увидеть, какой SQL будет выполнен, без реального применения.
🐸 Библиотека джависта
#Enterprise
Liquibase — это инструмент для версионирования схемы базы данных. Забудьте про ручные SQL-скрипты и проблемы с синхронизацией между окружениями.
Работает декларативно, отслеживает все изменения, поддерживает rollback и работает с любыми реляционными БД.
Нужна одна основная зависимость: liquibase-core. Если используете Spring Boot, добавьте spring-boot-starter-liquibase — он автоматически интегрируется с DataSource и запускается при старте приложения.
Критически важно добавить JDBC-драйвер вашей БД (postgresql, mysql-connector и т.д.). Без него Liquibase не сможет подключиться и применить миграции.
Создайте директорию resources/db/changelog/. В корне положите главный файл db.changelog-master.yaml — это точка входа, которая включает все остальные миграции.
В мастер-файле перечисляете пути к конкретным changeset-файлам в порядке применения. Называйте файлы по схеме: v1.0-create-users-table.yaml, v1.1-add-email-column.yaml — так проще ориентироваться в истории изменений.
В конфигурации укажите путь к мастер-файлу через параметр spring.liquibase.change-log. По умолчанию это classpath:db/changelog/db.changelog-master.yaml.
Обязательно настройте параметры enabled (включить/выключить), drop-first (очистка БД перед стартом — только для dev!) и contexts (для разделения миграций по окружениям: dev, test, prod).
Каждое изменение оборачивается в changeset с уникальным id и автором. Liquibase отслеживает, какие changeset'ы уже применены через служебную таблицу databasechangelog.
Основные типы изменений:
▪️ createTable / dropTable — создание/удаление таблиц
▪️ addColumn / dropColumn — добавление/удаление колонок
▪️ createIndex — создание индексов для оптимизации запросов
▪️ addForeignKey — настройка связей между таблицами
▪️ insert / update — заполнение справочников и тестовых данных
▪️ sql / sqlFile — для сложных кастомных запросов
Используйте preconditions для проверки условий перед применением: например, не создавать таблицу, если она уже существует.
Liquibase умеет откатывать изменения. Для большинства операций rollback генерируется автоматически, но для sql и sqlFile нужно явно указывать rollback-блок.
Добавляйте тег rollback с SQL-командами отката. Для createTable это будет dropTable, для addColumn — dropColumn. Это критически важно для production — без rollback вы не сможете откатить проблемную миграцию.
Используйте contexts и labels для разделения миграций. Тестовые данные помечайте context="dev", production-миграции — context="prod". При запуске приложения указывайте нужный context в конфигурации.
Можно создать отдельные файлы для каждого окружения: db.changelog-dev.yaml с тестовыми данными и db.changelog-prod.yaml только со структурными изменениями. Подключайте их условно через профили Spring.
▪️ Никогда не изменяйте уже применённые changeset'ы — создавайте новые для исправлений
▪️ Один changeset = одно атомарное изменение. Не пихайте всё в один файл
▪️ Используйте runOnChange="false" чтобы changeset применялся только один раз
▪️ Добавляйте failOnError="true" для критичных миграций
▪️ Тестируйте миграции на копии production БД перед деплоем
При старте приложения Liquibase подключается к БД и проверяет наличие служебных таблиц DATABASECHANGELOG и DATABASECHANGELOGLOCK. Если их нет — создаёт.
Затем читает master-файл, получает список всех changeset'ов и сверяет с таблицей DATABASECHANGELOG. Новые changeset'ы применяются последовательно, информация о них записывается в таблицу с MD5-хэшем для контроля целостности.
Интегрируйте Liquibase с CI/CD. Перед деплоем запускайте команду liquibase validate для проверки корректности changelog'ов. В pipeline добавьте команду liquibase updateSQL чтобы увидеть, какой SQL будет выполнен, без реального применения.
#Enterprise
Please open Telegram to view this post
VIEW IN TELEGRAM
👍10❤2🔥1
JMH — это фреймворк для точного микробенчмаркинга в Java
Он предназначен для создания тестов производительности, которые помогают анализировать, как различные изменения в коде влияют на его эффективность.
▪️ измерение времени выполнения на уровне микроопераций;
▪️ поддержка сложных случаев оптимизации JVM;
▪️ вывод подробной статистики;
▪️ возможность настройки параметров теста;
▪️ точные результаты без влияния JVM-оптимизаций.
#Enterprise
Please open Telegram to view this post
VIEW IN TELEGRAM
🔥7👍4❤1👏1
Вместо того чтобы копировать чужие манифесты с GitHub, вы настраиваете полноценный production-ready деплоймент через промпт.
Оптимизированный Dockerfile с multi-stage сборкой, Deployment с resource limits и health probes, Service Discovery через Kubernetes DNS, Ingress с TLS терминацией, автоскейлинг через HPA, NetworkPolicy для изоляции, RBAC для безопасности, и observability через Prometheus/Grafana.
📝 Промпт:
Generate a production-ready Spring Boot 3 application deployment to Kubernetes with enterprise-grade configuration:
— Create optimized multi-stage Dockerfile: Eclipse Temurin JDK 21, layered JAR, non-root user, distroless runtime image, minimal attack surface.
— Configure Kubernetes Deployment: resource requests/limits (CPU/memory), pod anti-affinity, PodDisruptionBudget, rolling update strategy with maxSurge/maxUnavailable, replica count.
— Implement health probes: liveness (/health/liveness), readiness (/health/readiness), startup probe for slow apps, custom health indicators, initial delays and timeouts.
— Set up configuration management: ConfigMaps for application.yml, Secrets for credentials, environment-specific overlays, volume mounts, Spring Cloud Kubernetes Config integration.
— Configure Service and Ingress: ClusterIP Service, NGINX Ingress with path/host routing, TLS termination via cert-manager, rate limiting, CORS policies.
— Implement RBAC: ServiceAccount, Role with least-privilege, RoleBinding, pod security context (runAsNonRoot, readOnlyRootFilesystem).
— Set up autoscaling: HorizontalPodAutoscaler based on CPU/memory/custom metrics, VerticalPodAutoscaler, scaling thresholds.
— Add NetworkPolicy: ingress/egress rules, namespace isolation, pod selector-based restrictions, deny-all default.
— Configure observability: Prometheus ServiceMonitor, Grafana dashboards, Spring Boot Actuator metrics, distributed tracing with Jaeger/Tempo, Loki for logs.
— Implement graceful shutdown: SIGTERM handling, preStop hooks, connection draining, termination grace period (30s+).
— Add secrets management: External Secrets Operator, HashiCorp Vault, AWS/GCP Secrets Manager CSI drivers.
— Create Helm chart: values.yaml with environment configs, templates for all resources, chart dependencies, deployment notes.
— Add Kustomize setup: base manifests, environment-specific overlays, ConfigMap generators.
— Configure init containers: database migrations (Flyway), wait-for-dependencies, secret fetching.
— Implement GitOps: ArgoCD Application manifest, sync policies, health checks, automated rollback.
Deliverables:
— Dockerfile with multi-stage build
— kubernetes/*.yaml (deployment, service, ingress, configmap, secret, hpa, networkpolicy)
— helm/ chart with templates and values
— kustomize/ with base and overlays
— prometheus-servicemonitor.yaml
— grafana-dashboard.json
— README with deployment guide and troubleshooting
— настроить service mesh (Istio) с mTLS;
— добавить canary deployments с Argo Rollouts;
— реализовать policy enforcement через Kyverno;
#Enterprise
Please open Telegram to view this post
VIEW IN TELEGRAM
👍7👏2🔥1🌚1
Пишешь SQL запрос в строке — ни подсветки синтаксиса, ни проверки, ни автодополнения. Опечатка в названии таблицы найдется только в рантайме. JSON в тесте? Вручную экранируешь кавычки и молишься, что не забыл запятую.
А IDEA умеет превращать строковые литералы в полноценные мини-редакторы с поддержкой нужного языка.
🔹 Что делает
— Внедряет поддержку другого языка (SQL, JSON, RegEx, HTML) внутри строкового литерала Java
— Включает подсветку синтаксиса, автодополнение, проверку ошибок для внедренного языка
— Позволяет редактировать в отдельном окне с полноценным редактором
— Понимает контекст: для SQL подключается к БД и предлагает реальные таблицы и колонки
🔹 Зачем это нужно
— Нативные SQL запросы в JDBC перестают быть черным ящиком — видишь ошибки до запуска
— JSON в тестовых данных валидируется на лету, форматируется одной кнопкой
— RegEx с подсветкой групп захвата и встроенным тестером
— HTML/XML в шаблонах проверяется на корректность структуры
— Xpath выражения с автодополнением элементов
🔹 Как использовать
— Автоматически: IDEA часто сама определяет язык (например, для методов createQuery, Pattern.compile)
— Вручную: Alt+Enter на строке → "Inject language or reference"
— Через аннотацию: добавить @Language("SQL") над String параметром
— Редактирование: Alt+Enter → "Edit SQL/JSON/RegEx fragment" — открывает полноценный редактор в popup
#Enterprise
Please open Telegram to view this post
VIEW IN TELEGRAM
👍8🔥2❤1
🔥 Как настроить Swagger/OpenAPI для документирования API
Swagger (OpenAPI) — стандарт описания REST API. Автогенерация документации, интерактивное тестирование через UI, генерация клиентов для различных языков.
Синхронизируется с кодом автоматически, поддерживает аннотации для детального описания и используется как контракт между фронтендом и бекендом.
1️⃣ Добавляем зависимости
Для Spring Boot 3.x используйте springdoc-openapi-starter-webmvc-ui. Это современная библиотека, заменившая устаревший springfox.
Одна зависимость подтягивает всё необходимое: генерацию спецификации, Swagger UI и валидацию. Автоматически интегрируется со Spring MVC и Spring Security.
2️⃣ Создаём базовую конфигурацию
Создайте класс OpenApiConfig аннотированный @Configuration. Определите bean OpenAPI с общей информацией: название API, версия, описание, контакты, лицензия.
Используйте Info, Contact, License для метаданных. Настройте servers() для указания базовых URL разных окружений (dev, staging, prod). Это позволит тестировать через UI на любом окружении.
3️⃣ Документируем контроллеры
Используйте @Tag на классе контроллера для группировки эндпоинтов. На методах применяйте @Operation(summary, description) для описания операции.
Аннотируйте параметры через @Parameter(description, required, example). Для тела запроса используйте @io.swagger.v3.oas.annotations.parameters.RequestBody с описанием и примерами. Добавляйте @Schema на DTO для описания полей модели.
4️⃣ Описываем ответы API
Используйте @ApiResponses с набором @ApiResponse для каждого возможного HTTP статуса. Укажите responseCode, description и content с примерами.
Создайте стандартные ErrorResponse классы и документируйте их через @Schema(description). Это даст консистентную обработку ошибок и понятную документацию для клиентов API.
5️⃣ Настраиваем Security схемы
Для JWT добавьте SecurityScheme через @SecurityScheme аннотацию на конфигурации. Укажите type = BEARERAUTH, scheme = "bearer", bearerFormat = "JWT".
На защищённых эндпоинтах используйте @SecurityRequirement(name = "bearerAuth"). Swagger UI автоматически добавит поле для ввода токена и будет подставлять его в заголовок Authorization.
6️⃣ Кастомизация и расширение
Настройте springdoc.swagger-ui.path для изменения URL (по умолчанию /swagger-ui.html). Включите tryItOutEnabled и supportedSubmitMethods для удобного тестирования.
Используйте springdoc.api-docs.path для изменения пути к JSON спецификации (по умолчанию /v3/api-docs). Для группировки API используйте @RouterOperations и группировку по packages или paths.
7️⃣ Best practices и продвинутые фичи
▪️ Используйте @Hidden на методах/контроллерах для исключения из документации
▪️ Добавьте примеры запросов/ответов через @ExampleObject для лучшего UX
▪️ Генерируйте client SDK через openapi-generator-maven-plugin
▪️ В production отключайте Swagger UI или закрывайте авторизацией
▪️ Используйте springdoc.show-actuator для документирования Actuator эндпоинтов
▪️ Включите springdoc.default-consumes/produces-media-type для дефолтных типов
✔️ Что происходит под капотом
При старте приложения springdoc сканирует все контроллеры, читает аннотации Spring и OpenAPI, анализирует сигнатуры методов и типы параметров.
Из этой информации генерируется OpenAPI спецификация в формате JSON/YAML. Swagger UI читает эту спецификацию и рендерит интерактивный интерфейс с формами для тестирования и документацией.
💡 Бонус-совет
Интегрируйте OpenAPI спецификацию в CI/CD для автоматической проверки breaking changes. Используйте openapi-diff для сравнения версий API. Публикуйте спецификацию в artifact repository для использования клиентами при генерации SDK.
🔹 Курс «Алгоритмы и структуры данных»
🔹 Получить консультацию менеджера
🔹 Сайт Академии 🔹 Сайт Proglib
🐸 Библиотека джависта
#Enterprise
Swagger (OpenAPI) — стандарт описания REST API. Автогенерация документации, интерактивное тестирование через UI, генерация клиентов для различных языков.
Синхронизируется с кодом автоматически, поддерживает аннотации для детального описания и используется как контракт между фронтендом и бекендом.
Для Spring Boot 3.x используйте springdoc-openapi-starter-webmvc-ui. Это современная библиотека, заменившая устаревший springfox.
Одна зависимость подтягивает всё необходимое: генерацию спецификации, Swagger UI и валидацию. Автоматически интегрируется со Spring MVC и Spring Security.
Создайте класс OpenApiConfig аннотированный @Configuration. Определите bean OpenAPI с общей информацией: название API, версия, описание, контакты, лицензия.
Используйте Info, Contact, License для метаданных. Настройте servers() для указания базовых URL разных окружений (dev, staging, prod). Это позволит тестировать через UI на любом окружении.
Используйте @Tag на классе контроллера для группировки эндпоинтов. На методах применяйте @Operation(summary, description) для описания операции.
Аннотируйте параметры через @Parameter(description, required, example). Для тела запроса используйте @io.swagger.v3.oas.annotations.parameters.RequestBody с описанием и примерами. Добавляйте @Schema на DTO для описания полей модели.
Используйте @ApiResponses с набором @ApiResponse для каждого возможного HTTP статуса. Укажите responseCode, description и content с примерами.
Создайте стандартные ErrorResponse классы и документируйте их через @Schema(description). Это даст консистентную обработку ошибок и понятную документацию для клиентов API.
Для JWT добавьте SecurityScheme через @SecurityScheme аннотацию на конфигурации. Укажите type = BEARERAUTH, scheme = "bearer", bearerFormat = "JWT".
На защищённых эндпоинтах используйте @SecurityRequirement(name = "bearerAuth"). Swagger UI автоматически добавит поле для ввода токена и будет подставлять его в заголовок Authorization.
Настройте springdoc.swagger-ui.path для изменения URL (по умолчанию /swagger-ui.html). Включите tryItOutEnabled и supportedSubmitMethods для удобного тестирования.
Используйте springdoc.api-docs.path для изменения пути к JSON спецификации (по умолчанию /v3/api-docs). Для группировки API используйте @RouterOperations и группировку по packages или paths.
▪️ Используйте @Hidden на методах/контроллерах для исключения из документации
▪️ Добавьте примеры запросов/ответов через @ExampleObject для лучшего UX
▪️ Генерируйте client SDK через openapi-generator-maven-plugin
▪️ В production отключайте Swagger UI или закрывайте авторизацией
▪️ Используйте springdoc.show-actuator для документирования Actuator эндпоинтов
▪️ Включите springdoc.default-consumes/produces-media-type для дефолтных типов
При старте приложения springdoc сканирует все контроллеры, читает аннотации Spring и OpenAPI, анализирует сигнатуры методов и типы параметров.
Из этой информации генерируется OpenAPI спецификация в формате JSON/YAML. Swagger UI читает эту спецификацию и рендерит интерактивный интерфейс с формами для тестирования и документацией.
Интегрируйте OpenAPI спецификацию в CI/CD для автоматической проверки breaking changes. Используйте openapi-diff для сравнения версий API. Публикуйте спецификацию в artifact repository для использования клиентами при генерации SDK.
🔹 Курс «Алгоритмы и структуры данных»
🔹 Получить консультацию менеджера
🔹 Сайт Академии 🔹 Сайт Proglib
#Enterprise
Please open Telegram to view this post
VIEW IN TELEGRAM
👍8❤2🔥1
Выбор структуры данных — это не только про знание API, но и про понимание:
— нужен ли random access;
— важна ли уникальность;
— критичен ли порядок элементов;
— как часто insert/delete в середине.
🔹 Курс «Алгоритмы и структуры данных»
🔹 Получить консультацию менеджера
🔹 Сайт Академии 🔹 Сайт Proglib
#Enterprise
Please open Telegram to view this post
VIEW IN TELEGRAM
👍9❤1🔥1🤔1