SpringDoc

Проработать

  1. Introduction
  2. Знакомство со спецификациями OpenAPI и Swagger

Что это

Swagger(OpenAPI) - это фреймворк для спецификации RESTful API. Его прелесть заключается в том, что он дает возможность не только интерактивно просматривать спецификацию, но и отправлять запросы – так называемый Swagger UI. Также возможно сгенерировать непосредственно клиента или сервер по спецификации API Swagger, для этого понадобится Swagger Codegen.

Основные разделы

Spring Boot подключение:

Добавление зависимости.

implementation 'org.springdoc:springdoc-openapi-starter-webmvc-ui:2.3.0'

Добавление настроек в "application.yml".

springdoc:
    swagger-ui:
        path: "/swagger-ui.html"

При запуске приложения, уже будет работать по адресу - http://localhost:8080/swagger-ui/index.html

Добавление описания API