Bom dia!
Uma dúvida... o SpringDoc e o Swagger UI fazem a mesma coisa? São Implementações do OpenAPI?
Só que o SpringDoc parece mais fácil pois não precisa adicionar várias anotaçoes nos métodos... E isso mesmo?
Obrigado!
Bom dia!
Uma dúvida... o SpringDoc e o Swagger UI fazem a mesma coisa? São Implementações do OpenAPI?
Só que o SpringDoc parece mais fácil pois não precisa adicionar várias anotaçoes nos métodos... E isso mesmo?
Obrigado!
Olá, Tiago!
Você está correto em suas observações. O SpringDoc e o Swagger UI são, de fato, implementações da especificação OpenAPI. Ambos têm como objetivo facilitar a documentação e o teste de APIs REST.
A diferença principal entre eles, como você notou, é a maneira como eles são usados. O Swagger UI requer a adição de várias anotações nos métodos para gerar a documentação, enquanto o SpringDoc simplifica esse processo, gerando a documentação automaticamente a partir do código da API.
Por exemplo, se você tem um método em um controlador como este:
@GetMapping("/hello")
public String hello() {
return "Hello, World!";
}
Com o Swagger, você precisaria adicionar anotações para documentar o método, algo como:
@ApiOperation(value = "Retorna uma saudação")
@GetMapping("/hello")
public String hello() {
return "Hello, World!";
}
Com o SpringDoc, no entanto, você não precisa adicionar nenhuma anotação. O SpringDoc irá gerar a documentação automaticamente a partir do código do método.
Portanto, se você está procurando uma maneira mais fácil e menos trabalhosa de documentar sua API, o SpringDoc pode ser a melhor opção para você.
Espero ter ajudado e bons estudos!