Data da publicação: 30/08/2025.
Neste tutorial vou explicar como baixar um projeto Spring Boot, como importar o projeto no eclipse e como criar sua primeira API Rest.
Conteúdo
1 Baixar o projeto Spring Boot
O primeiro passo é baixar o projeto Spring boot.
Para isso, você pode pesquisar no Google por "spring initializr" e clicar no link do correspondente. No momento que estou escrevendo este blog o link do website seria "https://start.spring.io/".
Na tela do Spring Initializr vão aparecer vário campos que deverão ser preenchidos, selecionados ou adicionados.
Reparem que tem duas metades da tela, começaremos preenchendo a metado da esquerda.
O primeiro item a ser selecionado é relacionado ao projeto, no caso as opções apresentadas são os gestores de dependências. Um gestor de dependência é um framework que facilita o download, inclusão e exclusão de bibliotecas dentro do seu projeto Java. Entenda por biblioteca um conjunto de códigos prontos e disponibilizados por uma pessoa, pela comunidade ou mesmo uma empresa, que estão disponíveis para ser usados agilizando nosso desenvolvimento. No nosso caso escolheremos Maven.
O segundo item a ser selecionado é a linguagem de programação que será usada, usaremos o Java.
O terceiro item é a versão do Spring Boot, repare que ele já vem pre-selecionado uma versão, que é a versão que ele recomenda, sendo assim eu recomendo que mantenha a versão pre-selecionada, mesmo que seja diferente da exibida nesse tutorial.
O quarto item, chamado "Project Metadata", é um grupo de campos que precisam ser preenchidos. Esses campos serão relacionados a nomenclatura, estruturação de pastas (pacotes) e descrição do seu projeto.
Em "Group" repare que foi colocado "br.com.lucasalbertoni.tutoriais", ou seja, para preencher esse campo tente atribuir o domínio do seu site ou do seu projeto de forma invertida e acrescente um "grupo" que identifica esse projeto no final, que no meu caso foi "tutoriais", ficando "br.com.lucasalbertoni.tutoriais".
Em "Artifact" e "Name" serão exibidos o mesmo valor. Para esse valor foi colocado "minha-primeira-api", ou seja, para preencher esse campo tente colocar o objetivo do projeto em si, por exemplo, se fosse um sistema relacionado a parte financeira da empresa, você poderia colocar "financeiro".
Em "Description" coloque uma descrição relevante ao objetivo do seu projeto que ajude outra pessoa a entendê-lo, no meu caso foi "Esse projeto será uma demonstração de como criar uma API".
O último campo, "Package name", será auto completado pelo que foi colocado em "Group" + "Artifact", sendo assim é só deixá-lo como esta.
O quinto item, chamado "Packaging", é o tipo de "empacotamento" que o seu projeto será feito. Pense que o "empacotamento" é quando você quer que o seu projeto seja executado em algum lugar, ou seja, você precisará compilar o seu código java criando os arquivos .class e colocá-los em um "pacote", que seria um arquivo, e esse arquivo é basicamente uma pasta com tudo o que será necessário para o seu programa java executar. Atualmente o modo de empacotamento mais utilizado é o .jar, que será o selecionado.
O sexto e último item do lado esquerdo da tela, chamado "Java", é a versão do Java, para esse tutorial será utilizada a versão 21.
Agora passaremos para o lado direito da tela.
Repare que essa tela é bem mais simples, tem apenas um campo, que é "Dependencies". Como abordado anteriormente, dependências, também conhecidas como bibliotecas, são conjunto de códigos desenvolvidos por outra pessoa, comunidade ou empresa que agilizam nosso desenvolvimento. Nesse campo só temos a opção de clicar no botão "ADD DEPENDECIES...", que é o que vamos fazer.
Ao clicar no botão aparecerá uma nova tela que você precisará digitar a dependência que quer inserir. Repare que já vem escrito algumas sugestões no campo de escrita "Web, Security, JPA, Actuator, Devtools".
Para esse tutorial utilizaremos apenas duas dependências, a Web e o Actuator. Então digite "web" e selecione a dependência "Spring Web".
Agora clique novamente no botão ADD Dependencies, digite actuator e selecione Spring Boot Actuator.
Pronto, agora que tudo esta preenchido, selecionado e adicionado só precisamos clicar no botão "GENERATE", localizado abaixo da tela e o projeto do Spring Boot será criados com tudo o que é necessário para desenvolvimento.
2 Importando o projeto no Eclipse
Após clicar no botão GENERATE, será gerado e baixado um arquivo .zip, como eu atribui o nome do projeto (Artifact) como "minha-primeira-api", o nome do arquivo foi baixado com o nome de "minha-primeira-api.zip". No meu caso ele foi baixado direto para pasta de Downloads.
Agora é aconselhado recortar e colar o arquivo em alguma outra estrutura de pasta que seja de sua fácil localização. Por exemplo, no meu caso eu criei um novo diretório chamado "tutoriais" dentro do "C:" e colei o arquivo la dentro.
Extraia os arquivos nessa pasta. Para extrair os arquivos clique com o botão direito do mouse sobre o arquivo e selecione "Extrair Tudo".
Repare que aparecerá uma pasta com o mesmo nome do arquivo .zip.
Será essa pasta que será utilizada como o Workspace do Eclipse. Sendo assim agora abra o Eclipse e selecione essa pasta como o workspace, no meu caso ficou "C:\tutoriais\minha-primeira-api", e então clique em "Launch".
Após algum tempo abrirá o eclipse e talvez aparecerá a tela de "Welcome", caso apareça pode fechar.
Na tela do eclipse, no topo do lado esquerdo, clique no item de menu "File", então clique no subitem de menu "Import".
Abrirá a tela de import, então digite "maven" e selecione "Existing Maven Projects". Então clique em Next.
Na próxima tela (Maven Projects), clique em Browse e na tela seguinte que abrirá clique em "Select Folder", sem selecionar nenhum diretório.
Feito isso é só clicar em "Finish" e então o eclipse cuidará de estruturar o projeto e o Maven cuidará de baixar as dependências necessários para o seu projeto.
3 Configurando e executando o projeto
Após o projeto ter sido importado e todas as dependências baixadas o projeto será apresentado sem nenhum erro no lado direito da tela na seção de "Projeto Explorer".
Abrindo as pastas, repare que foram criados pacotes com "_" e a classe "principal", que rodará o projeto, foi criada com o nome do "projeto + Application". Além disso dentro da pasta de resources foram criadas duas pastas "static" e "templates". Já dentro do pacote de test foi criada a classe com o nome do "projeto + ApplicationTest", que é usado para executar os testes integrados da aplicação. Por fim, repare que também existem três arquivos na raiz do projeto nomeados "HELP.md", "mvnw" e "mvnw.cmd".
Por questão de preferência, seguiremos o padrão de nomenclatura de pacotes com letras minúsculas e sem "_". Para renomear o pacote, selecione ele e clique em F2. No meu caso ao invés de ficar "minha_primeira_api", ficará "minhaprimeiraapi". Após renomear, o eclipse perguntará se você também deseja alterar a classe para utilizar o pacote correto, então clique em Continue. Faça esses mesmos passo para o pacote de teste também.
Agora iremos alterar o nome da classe principal e da de teste. Selecione a classe principal, no meu caso ela é "MinhaPrimeiraApiApplication.java", clique em F2 e então renomeie ela para "Application". Faça isso também para a classe de teste. Esse passo serve para simplificar o nome da classe do seu projeto, mas também é questão de preferência e não é obrigatório.
Alguns arquivos citados anteriormente não serão utilizados, sendo assim você pode excluir os arquivos "HELP.md", "mvnw" e "mvnw.cmd" da raiz do seu projeto e as pastas "static" e "templates" da pasta "resources" do seu projeto.
Pronto, agora podemos executar nosso projeto pela primeira vez. Clique com o botão direito em cima da classe "Application.java", então passe o mouse em cima do do ícone "Run As" e clique em "Java Application". Caso tenha funcionado será exibido um console com os logs do Spring e irá conter a mensagem "Tomcat started on port 8080 (http) with context path '/'", significando que o servidor do tomcate esta sendo executado. Repare que também tem um botão vermelho ao lado de um ícone de X, isso também indica que o seu programa esta rodando e esse botão serve para você parar a execução quando quiser, ou seja, quando você quiser parar a execução é só clicar nele e o seu servidor irá parar.
Lembra que selecionamos o framework Spring Actuator? Por conta desse framework nós já podemos acessar uma API que vem automaticamente adicionada. Essa API serve para exibir a "saúde" da aplicação, ou seja, se a aplicação está rodando corretamente. A principal API para verificar a saúde da aplicação é comument conhecida como "health check". Para acessá-la, basta ir até ao seu navegador com o servidor ainda rodando (por exemplo Google Chrome) e digite "http://localhost:8080/actuator/health" e você receberá uma resposta em formato json com o campo "status" com valor "up", significando que sua aplicação está ativa e funcionando corretamente.
4 Criando a sua API
Agora que já vimos que a aplicação está funcionando corretamente, podemos parar a execução clicando no quadrado vermelho, conforme falado anteriormente e criar uma nova class que representará nossa API.
Para criar a API, vamos seguir o padrão muito usado na área de desenvolvimento, que é criar um pacote chamado "controller" e dentro desse pacote criar nossa classe, que se chamará MinhaPrimeiraApiController.
Clique com o botão direito em cima da estrutura de pacote existente, então passe o mouse em cima de "New" e no submenu que abrirá clique em "package". Na janela que abriu chamada "New Java Package", no final do pacote existente no campo "Name" digite ".controller" e então clique em "Finish".
Após a criação do novo pacote, repare que aparecerá o mesmo, porém com o nome completo abaixo do existente.
Esse é o modo padrão que o Eclipse exibe chamado de "Flat", porém existe outro modo que eu prefiro. Para alterar a forma de exibição dos pacotes clique nos três pontos horizontais à direita do Project Explorer, próximo do funil de filtro, então arraste o mouse até o submenu "Package Presentation" e no outro submenu clique em "Hierarchical", com isso o eclipse passará a exibir os pacotes de forma hierárquica, ou seja, abaixo do pacote principal aparecerá apenas o pacote "controller" e não mais o nome completo.
Agora clique com o botão direito em cima do pacote "controller", então passe o mouse em cima de "New" e clique em "Class".
Na janela que abriu coloque o nome de "MinhaPrimeiraApi" e clique em Finish.
Agora iremos anotar essa classe com "@RestController", após escrever essa anotação clique em "CTRL + barra de espaço" para o eclipse sugerir o import da classe correta e aperte enter. Ao incluir esse anotação estamos informando para o framework Spring que essa classe será uma API rest.
Para termos uma rota definida para os métodos dessa classe, abaixo da anotação "@RestController", coloque outra anotação chamada "@RequestMapping", seguindo o mesmo procedimento anterior para importar a classe correta. Essa anotação permite passar uma String entre parênteses, então vamos passar a String "minha-primeira-api", ficando "@RequestMapping("minha-primeira-api")".
Pronto, agora nossa classe esta criada e pronto para receber requisições da rota que for "minha-primeira-api", porém para receber a requisição e processar a mesma, precisamos criar um método.
Crie um método público que retorne uma String e no retorno vamos colocar a String "Olá Mundo!". A última coisa a ser feita para que nossa API esteja completa é anotar esse método com @GetMapping, e já sabe, para importar a classe corretamente aperte CTRL + barra de espaço.
Repare que existe um asterisco ao lado esquerdo do nome da classe, no Eclipse isso indica que a classe não foi salva, clique em CTRL + s para salvar a classe. Após salvar a classe você já pode executar a aplicação novamente para testar nossa primeira api.
Para executar a aplicação, clique com o botão direito na classe "Application.java", passe o mouse em cima de "Run As" e então clique em "Java Application".
Por fim, com a aplicação rodando, vá ao navegador novamente e digite "http://localhost:8080/minha-primeira-api" e Pronto! Sua mensagem "Olá Mundo!" foi exibida! Parabéns, você conseguiu! Criou sua primeira API.
Conclusão
Após fazer esse tutorial você conseguiu baixar um projeto Spring Boot direto do site do Spring com as dependências necessárias para criar a API, conseguiu importar esse projeto no eclipse, conseguiu configurar o projeto para deixar as nomenclaturas mais simplificadas, conseguiu configurar a forma de exibição dos pacotes, conseguiu acessar a rota do actuator para verificar a saúde da aplicação e por fim conseguiu criar sua primeira API, então PARABÉNS!!