Зарегистрируйтесь для доступа к 15+ бесплатным курсам по программированию с тренажером

Open API Java: Корпоративные приложения на Spring Boot

OpenAPI – это спецификация для описания REST API. Она рассматривается как универсальный интерфейс для пользователей по взаимодействию с сервисами. На основании спроектированной для сервиса спецификации можно генерировать исходный код для библиотек клиентских приложений, текстовую документацию для пользователей и многое другое. Swagger — это набор инструментов, которые помогают описывать API.

Подключение

// Фрагмент файла build.gradle

// Подключаем плагин, который позволит записать
// полученную при помощи springdoc-openapi документацию в файл
plugins {
  id "com.github.johnrengelman.processes" version "0.5.0"
  id "org.springdoc.openapi-gradle-plugin" version "1.3.3"
  // другие плагины
}

// Подключаем зависимость, необходимую для интеграции spring boot и swagger
dependencies {
  implementation 'org.springdoc:springdoc-openapi-ui:1.5.12'
  // другие зависимости
}

Настройка

По умолчанию страница swagger ui открывается по адресу http://server:port/context-path/swagger-ui.html. Если нам нужно указать другой адрес, можно сделать это в файле application.yml

# Фрагмент файла application.yml
# Если нам нужно указать другой адрес, указываем его в свойстве path
springdoc:
  swagger-ui:
    path: /path

Аватары экспертов Хекслета

Остались вопросы? Задайте их в разделе «Обсуждение»

Вам ответят команда поддержки Хекслета или другие студенты.

Для полного доступа к курсу нужен базовый план

Базовый план откроет полный доступ ко всем курсам, упражнениям и урокам Хекслета, проектам и пожизненный доступ к теории пройденных уроков. Подписку можно отменить в любой момент.

Получить доступ
1000
упражнений
2000+
часов теории
3200
тестов

Открыть доступ

Курсы программирования для новичков и опытных разработчиков. Начните обучение бесплатно.

  • 130 курсов, 2000+ часов теории
  • 1000 практических заданий в браузере
  • 360 000 студентов
Отправляя форму, вы принимаете «Соглашение об обработке персональных данных» и соглашаетесь с «Условиями использования»

Наши выпускники работают в компаниях:

Логотип компании Альфа Банк
Логотип компании Aviasales
Логотип компании Yandex
Логотип компании Tinkoff
Рекомендуемые программы

С нуля до разработчика. Возвращаем деньги, если не удалось найти работу.

Иконка программы Java-разработчик
Профессия
с нуля
Разработка приложений на языке Java
8 декабря 10 месяцев

Используйте Хекслет по-максимуму!

  • Задавайте вопросы по уроку
  • Проверяйте знания в квизах
  • Проходите практику прямо в браузере
  • Отслеживайте свой прогресс

Зарегистрируйтесь или войдите в свой аккаунт

Отправляя форму, вы принимаете «Соглашение об обработке персональных данных» и соглашаетесь с «Условиями использования»

Изображение Тото

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