Упростите документацию по API с помощью Springdoc OpenAPI: как закрыть/свернуть теги по умолчанию

Методы закрытия/свертывания тегов по умолчанию в Springdoc OpenAPI:

Метод 1: использование свойства api-docs.
Один из способов добиться желаемого поведения — настроить свойство api-docsв файле application.properties или application.yml.. Установите для свойства springdoc.show-tagsзначение false, чтобы закрыть/свернуть все теги по умолчанию. Вот пример того, как это можно сделать в application.yml:

springdoc:
  show-tags: false

Метод 2: настройка конфигурации OpenAPI
Springdoc OpenAPI предоставляет способ настройки конфигурации OpenAPI с использованием bean-компонента типа OpenAPI. Вы можете расширить класс OpenAPIи переопределить свойство tags, чтобы добиться желаемого поведения. Вот пример:

@Configuration
public class OpenApiConfig {
  @Bean
  public OpenAPI customOpenAPI() {
    return new OpenAPI()
      .tags(Collections.emptyList()); // Close/collapse all tags by default
  }
}

Метод 3: использование свойства springdoc.swagger-ui.config
Другой подход — использовать свойство springdoc.swagger-ui.configдля настройки конфигурации пользовательского интерфейса Swagger. Установите для свойства springdoc.swagger-ui.config.tagsSorterзначение "alpha", чтобы по умолчанию закрывать/сворачивать теги. Вот пример:

springdoc:
  swagger-ui:
    config:
      tagsSorter: "alpha"

Метод 4. Программное изменение конфигурации пользовательского интерфейса Swagger
Если вы предпочитаете программную настройку, вы можете изменить конфигурацию пользовательского интерфейса Swagger с помощью bean-компонента типа SwaggerUiConfigParameters. Установите для свойства tagsSorterзначение "alpha", чтобы добиться желаемого поведения. Вот пример:

@Configuration
public class SwaggerUiConfig {
  @Bean
  public SwaggerUiConfigParameters swaggerUiConfigParameters() {
    SwaggerUiConfigParameters parameters = new SwaggerUiConfigParameters();
    parameters.setTagsSorter("alpha"); // Close/collapse tags by default
    return parameters;
  }
}