0

Antes e depois do Swagger

Alex Sousa
Alex Sousa

Antes de conhecer o swagger eu documentava meus apps de forma muito trabalhosa, usando markdown. Até conhecia o swagger mas para a linguagem a qual eu estava estudando, ainda dava um pouco de trabalho para configurar.


Já usando ele no spring, as coisas funcionam de forma "automágicamente".


Basta colocar as seguintes dependências no arquivo pom.xml:


<dependency>
   <groupId>org.springdoc</groupId>
   <artifactId>springdoc-openapi-ui</artifactId>
   <version>1.5.2</version>
</dependency>


Em seguida abaixo do seu método principal, colocar a anotação @Bean e o método OpenAPI:

public OpenAPI customOpenAPI(@Value("Nome da API") String description){
   return new OpenAPI()
         .info(new Info()
         .title(description)
         .version("1.0")
         .termsOfService("http://suagger.io/terms")
         .license(new License().name("Apache 2.0")
         .url("http://springdoc.org")));
}


Para olhar a sua documentação rodando, basta colocar no endereço raíz do seu endpoint a seguinte rota:

http://localhost:8080/swagger-ui.html



0
0

Comentários (2)

0
Alex Sousa

Alex Sousa

01/07/2021 15:54

Um mão na roda!

1
Richard Nascimento

Richard Nascimento

01/07/2021 14:53

Ajuda demais, né?


Produtividade é tudo. Parabéns!

Analista e Desenvolvedor de Sistemas

Brasil