OpenApiConfig

java.lang.Object

diegosneves.github.conectardoacoes.adapters.rest.config.web.OpenApiConfig

@Configuration public class OpenApiConfig extends Object

Classe de configuração para a documentação da API aberta (OpenAPI).

Esta classe configura as informações detalhadas e as tags que são exibidas na documentação do Swagger/OpenAPI.

Isso inclui meta-informações como a versão da API, título, descrição, detalhes de contato e tags usadas para agrupar endpoints relacionados.

Since:: 1.0.0
Author:: diegosneves

Constructor Summary

Constructors

Constructor

Description

OpenApiConfig()
Method Summary

Modifier and Type

Method

Description

io.swagger.v3.oas.models.OpenAPI

customOpenAPI()

Retorna uma instância personalizada do OpenAPI.

private io.swagger.v3.oas.models.info.Info

getInfo()

Busca informações sobre a API.

private List<io.swagger.v3.oas.models.tags.Tag>

getTags()

Recupera a lista de Etiquetas (Tags).

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details
- OpenApiConfig
  
  public OpenApiConfig()
Method Details
- customOpenAPI
  
  @Bean public io.swagger.v3.oas.models.OpenAPI customOpenAPI()
  
  Retorna uma instância personalizada do OpenAPI.
  Este método configura informações detalhadas e tags que serão exibidas na documentação Swagger/OpenAPI.
  
  Returns:
  
  a instância personalizada do OpenAPI
- getInfo
  
  private io.swagger.v3.oas.models.info.Info getInfo()
  
  Busca informações sobre a API.
  
  Returns:
  
  Uma instância da classe Info contendo versão, título, descrição e detalhes de contato
- getTags
  
  private List<io.swagger.v3.oas.models.tags.Tag> getTags()
  
  Recupera a lista de Etiquetas (Tags).
  
  Returns:
  
  Uma lista de Etiquetas (Tags), cada uma contendo um nome e uma descrição que detalham a finalidade da respectiva Etiqueta.