Duvida de como consumir uma API externa com spring

Classes DTO:

@Data
public class Regiao {

    private Long id;
    private String sigla;
    private String nome;

}

@Data
public class UF {

    private Long id;
    private String sigla;
    private String nome;
    private Regiao regiao;

}
@Data
public class MicroRegiao {


    private Long id;
    private String nome;
    private MesoRegiao mesoregiao;

}
@Data
public class MesoRegiao {


    private Long id;
    private String nome;
    private UF uf;

}
@Data
public class RegiaoIntermediaria {

    private Long id;
    private String nome;
    private UF uf;
}
@Data
public class RegiaoImediata {

    private Long id;
    private String nome;
    private RegiaoIntermediaria regiaoIntermediaria;

}

@Data
public class Municipio {


    private Long id;
    private String nome;
    private MicroRegiao microRegiao;
    private RegiaoImediata regiaoImediata;
}
@Data
public class Distritos {


    private Long id;
    private String nome;
    private Municipio municipio;
}

@Data
public class DistritosList {

    private List<Distritos> distritoList;


    public DistritosList() {

        distritoList = new ArrayList<>();
    }
}

Classe Service

@Service
public class IbgeService {


    public ResponseEntity<Distritos[]> retornarDistritos(String codIbge) {

        //https://servicodados.ibge.gov.br/api/v1/localidades/microrregioes/3509502/distritos
        String URI = "https://servicodados.ibge.gov.br/api/v1/localidades/microrregioes/"+codIbge+"/distritos";

          RestTemplate restTemplate = new RestTemplate();

          System.out.println("#### URL: "+ URI);
         // Distritos[] distritos = restTemplate.getForObject(URI, Distritos[].class);
          ResponseEntity<Distritos[]> distritos =  restTemplate.getForEntity(URI,Distritos[].class);


          return distritos;
    }

Controller

@RestController
@RequestMapping("/distrito")
public class DistritoController {

    @Autowired
    private IbgeService ibgeService;

    @GetMapping("/{numero}")
    public ResponseEntity<ResponseEntity<Distritos[]>> consultarDistrito(@PathVariable String numero) {

        ResponseEntity<Distritos[]> distritos = ibgeService.retornarDistritos(numero);
        return ResponseEntity.ok(distritos);
    }

Minha duvida é como retornar array de forma correta utilizando o RestTemplate e o que pode ser melhorado neste código, desde já muito obrigado.

Oi Marcos,

O codigo esta bacana e certinho :)

O RestTemplate deveria ter devolvido apenas o body com o json e nao os dados completos da resposta da requisicao.

De qualquer forma, o RestTemplate vai ser descontinuado em breve pelo Spring e agora voce deve realizar uma consulta Rest da seguinte maneira:

<dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-webflux</artifactId>
</dependency>

String url = "https://servicodados.ibge.gov.br";
String uri = "/api/v1/localidades/municipios/{codigoIbge}/distritos";

Distritos[] distritos = WebClient
            .create(url)
            .get()
            .uri(uri, codigoIbge)
            .retrieve()
            .bodyToMono(Distritos[].class).block();

Veja se assim funciona certinho.

Bons estudos!

Olá Rodrigo, obrigado pelo retorno, realizei a seguinte implementação porém o json ainda não vem populado corretamente, os arrays microregião e regiao imediata não são populados quando chamo pela minha aplicação:

classe service

public Distritos[] retornarDistritos2(String codIbge){
        String url = "https://servicodados.ibge.gov.br";
        String uri = "/api/v1/localidades/microrregioes/{codigoIbge}/distritos";

        Distritos[] distritos = WebClient
                    .create(url)
                    .get()
                    .uri(uri, codIbge)
                    .retrieve()
                    .bodyToMono(Distritos[].class).block();

        return distritos;
    }

Controller

    @GetMapping("/novo/{numero}")    
public ResponseEntity consultarDistritoWebFlux(@PathVariable String numero) {

        Distritos[] distritos = ibgeService.retornarDistritos2(numero);
        return ResponseEntity.ok(distritos);
    }

link de teste utlizado: https://servicodados.ibge.gov.br/api/v1/localidades/microrregioes/16003/distritos

link que utilizei no postman para testar a aplicação:http://localhost:8080/distrito/novo/16003

o código acima esta correto?

Oi Marcos,

O codigo esta correto sim.

O problema agora é que o nome de alguns dos seus atributos esta diferente do que vem no json.

Por exemplo, no json do ibge tem os atributos com esses nomes: microrregiao, mesorregiao e regiao-imediata, mas nas suas classes DTO os atributos estao com nomes que nao sao iguais: microRegiao, mesoregiao e regiaoImediata.

Por isso o Spring nao consegue fazer a conversao dessas informacoes para o DTO.

Voce pode utilizar a anotacao @JsonAlias nesses casos:

@JsonAlias("regiao-imediata")
private RegiaoImediata regiaoImediata

Realize esses ajustes que deve funcionar.

oi Rodrigo, usei a anotação indicada e funcionou corretamente muito obrigado!