Criando uma API RESTful com a JAX-RS API \| TreinaWeb Promoção no ar Matricule-se agora e garanta **54% de desconto** Termina em Tempo restante da oferta: 17 Horas 09 Min 35 Seg Tempo restante da oferta: 17 09 35 [Assinar →](https://www.treinaweb.com.br/checkout/pagamento/plano/anual?cupom=TW-SCLIENTE26) [ ](https://www.treinaweb.com.br) Explorar [ Quanto custa? ](#assinatura) [ FAQ ](https://www.treinaweb.com.br#faq) [Matricule-se](#assinatura) [ Entrar ](https://www.treinaweb.com.br/login) [ Início ](https://www.treinaweb.com.br) [ Artigos ](https://www.treinaweb.com.br/blog) Criando uma API RESTful com a JAX-RS API [ Java ](https://www.treinaweb.com.br/blog/categoria/java) # Criando uma API RESTful com a JAX-RS API O Java define a especificação JAX-RS API para a criação de aplicações API RESTful, que pode ser facilmente utilizada com a implementação do Jersey. [ Wladimilson M. Nascimento ](https://www.treinaweb.com.br/blog/autor/wladimilson-m-nascimento) 7 anos atrás ![](https://dkrn4sk0rn31v.cloudfront.net/uploads/2020/05/criando-api-restful-jax-rs-api.png) No Java, quando pensamos na criação de uma API RESTful a primeira opção que vem a mente é o projeto Spring. Este projeto facilita a [criação de APIs REST com o Spring Boot](https://www.treinaweb.com.br/blog/criando-uma-api-rest-com-o-spring-boot/), que é uma das bibliotecas fornecidas por ele. Entretanto, o Java define uma especificação para este tipo de aplicação, a [JAX-RS API](https://github.com/jax-rs). Mesmo não possuindo tanto destaque quanto o Spring Boot, como veremos neste artigo, é bem simples criar uma API REST com a JAX-RS API. [ ![Java - Fundamentos de JAX-WS e JAX-RS](https://d2knvm16wkt3ia.cloudfront.net/assets/svg-icon/java.svg) Curso Java - Fundamentos de JAX-WS e JAX-RS Conhecer o curso ](https://www.treinaweb.com.br/curso/java-fundamentos-de-jax-ws-e-jax-rs) ## A especificação JAX-RS API A JAX-RS API trata-se de uma especificação, ela define interfaces e anotações fornecidas pelo Java EE, que podem ser utilizadas na criação de uma API RESTful. Um desenvolvedor pode criar a sua aplicação baseada unicamente nesta especificação, entretanto o usual é fazer uso de uma biblioteca que a implemente. Entre as bibliotecas existentes, as implementações da JAX-RS API mais conhecidas são [RESTEasy](http://resteasy.jboss.org/) e [Jersey](https://jersey.java.net/). Sendo que a mais utilizada é a Jersey, assim neste artigo faremos uso dela. Então vamos colocar a mão na massa. ## Criando a aplicação Para este artigo irei criar um projeto Maven utilizando o arquétipo `jersey-quickstart-grizzly2`, pois este arquétipo já possui o Jersey configurado e fornece embutido o servidor [Grizzly](https://javaee.github.io/grizzly/). Pelo terminal, o projeto pode ser criado com o comando abaixo: ```dos mvn archetype:generate -DarchetypeArtifactId=jersey-quickstart-grizzly2 \ -DarchetypeGroupId=org.glassfish.jersey.archetypes -DinteractiveMode=false \ -DgroupId=br.com.treinaweb -DartifactId=jaxrsexample -Dpackage=br.com.treinaweb ``` No arquivo **pom.xml** haverão as dependências do Jersey: ```xml org.glassfish.jersey.containers jersey-container-grizzly2-http org.glassfish.jersey.inject jersey-hk2 ``` Caso não queira utilizar o Jersey com o Grizzly, você pode substituir a primeira dependência acima pelas abaixo: ```xml org.glassfish.jersey.core jersey-server org.glassfish.jersey.containers jersey-container-servlet ``` Com o projeto criado e o Jersey configurado, vamos começar a criar a nossa API REST com JAX-RS API. ## Criando uma entidade e repositório Este exemplo será um CRUD simples, mas para isso necessitamos de uma entidade, que será representada pela classe abaixo: ```java public class Pessoa { private int id; private String nome; private int idade; public int getId() { return id; } public int getIdade() { return idade; } public void setIdade(int idade) { this.idade = idade; } public String getNome() { return nome; } public void setNome(String nome) { this.nome = nome; } public void setId(int id) { this.id = id; } } ``` Esta aplicação não lidará com um banco de dados, assim o repositório utilizará um hashmap na memória: ```java public class PessoaRepository { private final static HashMap pessoas = new HashMap(); public List GetAll(){ return new ArrayList(pessoas.values()); } public Pessoa Get(final int id) { return pessoas.get(id); } public void Add(final Pessoa pessoa) { if(pessoa.getId() == 0 ) pessoa.setId(generateId(pessoas.size() + 1)); pessoas.put(pessoa.getId(), pessoa); } public void Edit(final Pessoa pessoa) { pessoas.remove(pessoa.getId()); pessoas.put(pessoa.getId(), pessoa); } public void Delete(final int id) { pessoas.remove(id); } private int generateId(final int possible) { if(pessoas.containsKey(possible)) return generateId(possible + 1); return possible; } } ``` Agora podemos criar o nosso recurso. ## Recursos No Jersey os endpoints são chamados de recursos. Um recurso nada mais é que uma classe que contém a anotação `@Path`: ```java import javax.ws.rs.Path; @Path("/pessoa") public class PessoaResource { } ``` Como é possível notar no código acima, a anotação `@Path` é utilizada para indicar um caminho. Ao defini-lo na classe, significa que este será o nosso endpoint. Dentro dela, definimos métodos que representam os [verbos HTTP](https://www.treinaweb.com.br/blog/o-que-e-http-request-get-post-response-200-404/), onde cada método deverá conter a anotação equivalente ao verbo que o invocará: - `@DELETE` = `DELETE`; - `@GET` = `GET`; - `@HEAD` = `HEAD`; - `@OPTIONS` = `OPTIONS`; - `@POST` = `POST`; - `@PUT` = `PUT`; - `@PATCH` = `PATCH`. Neste nosso endpoint não utilizaremos todas essas anotações, apenas as equivalentes aos principais verbos: `DELETE`, `GET`, `POST` e `PUT`. Ao realizar este procedimento, a classe ficará com o seguinte código: ```java import java.util.List; import javax.ws.rs.Consumes; import javax.ws.rs.DELETE; import javax.ws.rs.GET; import javax.ws.rs.POST; import javax.ws.rs.PUT; import javax.ws.rs.Path; import javax.ws.rs.PathParam; import javax.ws.rs.Produces; import javax.ws.rs.core.MediaType; import javax.ws.rs.core.Response; import br.com.treinaweb.model.Pessoa; import br.com.treinaweb.repositories.PessoaRepository; @Path("/pessoa") public class PessoaResource { private PessoaRepository _repositorio = new PessoaRepository(); @GET @Produces(MediaType.APPLICATION_JSON) public List get() { return _repositorio.GetAll(); } @GET @Path("{id}") @Produces(MediaType.APPLICATION_JSON) public Pessoa getById(@PathParam("id") int id) { return _repositorio.Get(id); } @POST @Produces(MediaType.APPLICATION_JSON) @Consumes(MediaType.APPLICATION_JSON) public Response post(Pessoa pessoa) { try{ _repositorio.Add(pessoa); return Response.status(Response.Status.CREATED).entity(pessoa).build(); } catch(Exception ex) { return Response.status(Response.Status.INTERNAL_SERVER_ERROR).entity(ex.getMessage()).build(); } } @PUT @Path("{id}") @Produces(MediaType.APPLICATION_JSON) @Consumes(MediaType.APPLICATION_JSON) public Response put(@PathParam("id") int id, Pessoa pessoa) { Pessoa p = _repositorio.Get(id); if(p == null) return Response.status(Response.Status.NOT_FOUND).build(); try{ pessoa.setId(id); _repositorio.Edit(pessoa); return Response.status(Response.Status.OK).entity(pessoa).build(); } catch(Exception ex) { return Response.status(Response.Status.INTERNAL_SERVER_ERROR).entity(ex.getMessage()).build(); } } @DELETE @Path("{id}") @Produces(MediaType.APPLICATION_JSON) public Response delete(@PathParam("id") int id) { Pessoa p = _repositorio.Get(id); if(p == null) return Response.status(Response.Status.NOT_FOUND).build(); try{ _repositorio.Delete(id); return Response.status(Response.Status.OK).build(); } catch(Exception ex) { return Response.status(Response.Status.INTERNAL_SERVER_ERROR).entity(ex.getMessage()).build(); } } } ``` Repare que os métodos também definem o tipo de conteúdo que irão produzir/retornar: ```java @GET @Produces(MediaType.APPLICATION_JSON) public List get() { return _repositorio.GetAll(); } ``` E o tipo que irão consumir: ```java @POST @Produces(MediaType.APPLICATION_JSON) @Consumes(MediaType.APPLICATION_JSON) public Response post(Pessoa pessoa) { try{ _repositorio.Add(pessoa); return Response.status(Response.Status.CREATED).entity(pessoa).build(); } catch(Exception ex) { return Response.status(Response.Status.INTERNAL_SERVER_ERROR).entity(ex.getMessage()).build(); } } ``` O Jersey se encarregará de converter o objeto retornado para JSON e o JSON recebido para o tipo do objeto indicado. Mas para que esta a conversão seja possível, é necessário definir a dependência abaixo (caso não esteja definida): ```xml org.glassfish.jersey.media jersey-media-json-binding ``` Pronto, a nossa aplicação já pode ser utilizada. ## Testando a aplicação Caso esteja acompanhando este artigo e se o seu projeto foi criado com base o arquetipo `jersey-quickstart-grizzly2`, você pode compilar os códigos pelo Maven: ```dos mvn clean compile ``` E executar o servidor embutido da aplicação: ```dos mvn exec:java ``` Indiferente da forma que a aplicação é executada, poderemos interagir com o nosso endpoint: ### POST: ![Tela no Postman, mostrando o exemplo de uma requisição POST para o endpoint “http://localhost:8080/pessoa”](https://dkrn4sk0rn31v.cloudfront.net/uploads/2020/05/requisicao-post-no-postman.png) ### GET: ![Tela no Postman, mostrando o exemplo de uma requisição GET para o endpoint “http://localhost:8080/pessoa”](https://dkrn4sk0rn31v.cloudfront.net/uploads/2020/05/requisicao-get-no-postman.png) ### PUT: ![Tela no Postman, mostrando o exemplo de uma requisição PUT para o endpoint “http://localhost:8080/pessoa/1](https://dkrn4sk0rn31v.cloudfront.net/uploads/2020/05/requisicao-put-no-postman.png) ### GET ID: ![Tela no Postman, mostrando o exemplo de uma requisição GET para o endpoint “http://localhost:8080/pessoa/1”](https://dkrn4sk0rn31v.cloudfront.net/uploads/2020/05/requisicao-get-para-um-id-no-postman.png) ### DELETE: ![Tela no Postman, mostrando o exemplo de uma requisição DELETE para o endpoint “http://localhost:8080/pessoa/1”](https://dkrn4sk0rn31v.cloudfront.net/uploads/2020/05/requisicao-delete-no-postman.png) [ ![C Básico](https://d2knvm16wkt3ia.cloudfront.net/assets/svg-icon/c.svg) Curso C Básico Conhecer o curso ](https://www.treinaweb.com.br/curso/c-basico) ## Conclusão A JAX-RS API é uma poderosa especificação que pode ser aplicada em uma aplicação facilmente graças a implementação do Jersey, se tornando uma ótima alternativa para o Spring Boot. Desta forma, caso necessite criar uma aplicação RESTfull API no Java, não deixe de dar uma olhada nos recursos fornecidos pela JAX-RS API e o Jersey. Você pode baixar a aplicação deste artigo no meu [Github](https://github.com/wladimilson/jax-rs-example). - [ #Java ](https://www.treinaweb.com.br/blog/tag/java) - [ #API ](https://www.treinaweb.com.br/blog/tag/api) - [ #REST ](https://www.treinaweb.com.br/blog/tag/rest) - [ #API REST ](https://www.treinaweb.com.br/blog/tag/api-rest) - [ #Spring ](https://www.treinaweb.com.br/blog/tag/spring) - [ #Spring Boot ](https://www.treinaweb.com.br/blog/tag/spring-boot) - [ #JAX-RS API ](https://www.treinaweb.com.br/blog/tag/jax-rs-api) Autor ![Wladimilson M. Nascimento](//secure.gravatar.com/avatar/f0dd442f156a3eacd2880e9cd0eafbd1?d=mm) ## Wladimilson M. Nascimento Instrutor, nerd, cinéfilo e desenvolvedor nas horas vagas. Graduado em Ciências da Computação pela Universidade Metodista de São Paulo. [Todos os artigos](https://www.treinaweb.com.br/blog/autor/wladimilson-m-nascimento) ## Continue estudando Transforme leitura em prática com os cursos e formações da TreinaWeb. [Ver cursos](https://www.treinaweb.com.br/cursos) Continue lendo ## Artigos relacionados - ![](https://dkrn4sk0rn31v.cloudfront.net/uploads/2019/12/03143715/CARTER-400x280.png) [ Desenvolvimento Back-end ](https://www.treinaweb.com.br/blog/categoria/desenvolvimento-back-end) 7 anos atrás ## [ Criando uma API RESTful com o Carter e .NET Core ](https://www.treinaweb.com.br/blog/criando-uma-api-restful-com-o-carter-e-net-core) O Carter é um framework para .NET Core, que permite criar API RESTful de forma rápida, simples e elegante. O conheça neste artigo. Ler artigo - ![](https://dkrn4sk0rn31v.cloudfront.net/uploads/2018/11/03160827/NANCY-400x280.png) [ C# ](https://www.treinaweb.com.br/blog/categoria/csharp) 8 anos atrás ## [ Criando uma API RESTful com o NancyFx e .NET Core ](https://www.treinaweb.com.br/blog/criando-uma-api-restful-com-o-nancyfx-e-net-core) O NancyFX é um leve framework para o C#. Veja como utilizá-lo para criar uma API RESTful. Ler artigo - ![](https://dkrn4sk0rn31v.cloudfront.net/uploads/2022/08/asp-net-conhecendo-as-minimal-api-400x280.png) [ C# ](https://www.treinaweb.com.br/blog/categoria/csharp) 4 anos atrás ## [ ASP.NET - Conhecendo a Minimal API ](https://www.treinaweb.com.br/blog/asp-net-conhecendo-as-minimal-api) Neste artigo vamos conhecer um dos recursos que foram adicionados no .NET 6/ASP.NET 6, que é um novo template de aplicações Web, a Minimal API. Ler artigo - ![](https://dkrn4sk0rn31v.cloudfront.net/uploads/2019/12/16113045/GRPC-400x280.png) [ Desenvolvimento Back-end ](https://www.treinaweb.com.br/blog/categoria/desenvolvimento-back-end) 7 anos atrás ## [ Serviços gRPC no ASP.NET Core ](https://www.treinaweb.com.br/blog/servicos-grpc-no-asp-net-core) Aprenda o que é gRPC e como criar um serviço com esta tecnologia no ASP.NET Core. Ler artigo - ![](https://dkrn4sk0rn31v.cloudfront.net/uploads/2019/09/09160454/SGBDs-400x280.png) [ Bancos de Dados ](https://www.treinaweb.com.br/blog/categoria/bancos-de-dados) 5 anos atrás ## [ Tipos de banco de dados NoSQL ](https://www.treinaweb.com.br/blog/tipos-de-banco-de-dados-nosql) Veja neste artigo os principais tipos de banco de dados NoSQL. Ler artigo - ![](https://dkrn4sk0rn31v.cloudfront.net/uploads/2022/01/criando-uma-api-com-spring-data-jpa-e-spring-web-400x280.png) [ Desenvolvimento Back-end ](https://www.treinaweb.com.br/blog/categoria/desenvolvimento-back-end) 5 anos atrás ## [ Criando uma API com Spring Data JPA e Spring Web ](https://www.treinaweb.com.br/blog/criando-uma-api-com-spring-data-jpa-e-spring-web) Neste artigo vamos aprender como criar uma API com persistência de dados utilizando o Spring Web MVC e o Spring Data JPA. Ler artigo - ![](https://dkrn4sk0rn31v.cloudfront.net/uploads/2019/07/05112250/SPRING-BOOT-400x280.png) [ Desenvolvimento Back-end ](https://www.treinaweb.com.br/blog/categoria/desenvolvimento-back-end) 7 anos atrás ## [ Criando uma API REST com o Spring Boot ](https://www.treinaweb.com.br/blog/criando-uma-api-rest-com-o-spring-boot) Todos os passos da criação de uma API REST com o framework Spring Boot do Java, no Visual Studio Code. Ler artigo - ![](https://dkrn4sk0rn31v.cloudfront.net/uploads/2019/04/16095041/OCELOT-400x280.png) [ C# ](https://www.treinaweb.com.br/blog/categoria/csharp) 8 anos atrás ## [ Criando um API Gateway com ASP.NET Core e Ocelot ](https://www.treinaweb.com.br/blog/criando-um-api-gateway-com-asp-net-core-e-ocelot) Conheça o conceito de API Gateway e veja como criá-lo em uma aplicação ASP.NET utilizando a biblioteca Ocelot. Ler artigo - ![](https://dkrn4sk0rn31v.cloudfront.net/uploads/2020/01/06113752/streaming-api-400x280.png) [ C# ](https://www.treinaweb.com.br/blog/categoria/csharp) 7 anos atrás ## [ ASP.NET Core - Criando uma Streaming API ](https://www.treinaweb.com.br/blog/asp-net-core-criando-uma-streaming-api) Streaming não se resume apenas a conteúdo de media. Aprenda neste artigo como criar uma streaming API de dados no ASP.NET Core. Ler artigo - ![](https://dkrn4sk0rn31v.cloudfront.net/uploads/2022/03/o-que-e-fastapi-400x280.png) [ Desenvolvimento Back-end ](https://www.treinaweb.com.br/blog/categoria/desenvolvimento-back-end) 4 anos atrás ## [ Criando o primeiro CRUD com FastAPI ](https://www.treinaweb.com.br/blog/criando-o-primeiro-crud-com-fastapi) Neste artigo nós iremos aprender um pouco mais sobre o FastAPI durante o desenvolvimento de uma API com todas as operações de CRUD. Ler artigo - ![](https://dkrn4sk0rn31v.cloudfront.net/uploads/2020/01/05103838/SIGNALR-400x280.png) [ C# ](https://www.treinaweb.com.br/blog/categoria/csharp) 7 anos atrás ## [ Criando um Chat com ASP.NET Core SignalR ](https://www.treinaweb.com.br/blog/criando-um-chat-com-asp-net-core-signalr) Continuando o estudo do SignalR, aprenda como criar um chat utilizando esta biblioteca de aplicações em tempo real do ASP.NET Core. Ler artigo - ![](https://dkrn4sk0rn31v.cloudfront.net/uploads/2018/01/10094842/service-stack-1-400x280.png) [ C# ](https://www.treinaweb.com.br/blog/categoria/csharp) 9 anos atrás ## [ Criando um Web Service com o ServiceStack - Parte 1 ](https://www.treinaweb.com.br/blog/criando-um-web-service-com-o-servicestack-parte-1) Nesta primeira parte, veja como criar um web service simples no .NET Core utilizando a biblioteca ServiceStack. Ler artigo ## Um ano de acesso total para você viver de programação. Todos os cursos e formações da TreinaWeb numa única assinatura, com professores que atuam no mercado, suporte direto e certificados. Do primeiro `console.log` ao mercado de trabalho. - **1 ano** de acesso a **todos os cursos** - Cursos novos **toda semana** - Suporte **direto com professores** - Plano de carreira **personalizado** - **Certificados digitais** inclusos - **Aplicativos** para Android e iOS, com **acesso offline** **Garantia incondicional de satisfação** Teste por 7 dias e, se não fizer sentido para você, devolvemos seu dinheiro. ### Acesso completo a todos os cursos e dezenas de Formações. 12 meses Economize R$ 840,00 54% OFF de 12x R$ 129,00 por apenas 12x R$ 59,00 sem juros no cartão de crédito ou R$ 599,00 à vista Oferta termina em **17h 09min 35s** - Acesso imediato e ilimitado durante 1 ano. - Plano de carreira personalizado. - Suporte direto com professores. - E muito mais! [Matricule-se agora](https://www.treinaweb.com.br/checkout/pagamento/plano/anual?cupom=TW-SCLIENTE26) [ ](https://www.treinaweb.com.br) Escola online de programação, tecnologia e IA. - [ ](https://www.facebook.com/TreinaWeb/) - [ ](https://www.instagram.com/treinaweb/) - [ ](https://www.youtube.com/user/TreinaWeb) - [ ](https://twitter.com/treinaweb) - [ ](https://www.linkedin.com/company/treinaweb) - [ ](https://github.com/treinaweb) ## Inscreva-se em nossa newsletter Receba lançamentos, promoções e novidades. Seu nome Seu WhatsApp Seu melhor e-mail Inscrever-se ## Cursos - [ Base para Devs ](https://www.treinaweb.com.br/categoria/base-para-devs) - [ Front-end ](https://www.treinaweb.com.br/categoria/desenvolvimento-front-end) - [ Back-end ](https://www.treinaweb.com.br/categoria/desenvolvimento-back-end) - [ Mobile ](https://www.treinaweb.com.br/categoria/desenvolvimento-mobile) - [ Bancos de Dados ](https://www.treinaweb.com.br/categoria/bancos-de-dados) - [ Cloud ](https://www.treinaweb.com.br/categoria/cloud-computing) - [ IA ](https://www.treinaweb.com.br/categoria/ia) - [ E mais ](https://www.treinaweb.com.br/categoria/e-mais) - [ Ver todos os cursos ](https://www.treinaweb.com.br/cursos) ## Conteúdo - [ Formações ](https://www.treinaweb.com.br/formacoes) - [ Projetos práticos ](https://www.treinaweb.com.br/projetos-praticos) - [ Direto ao ponto ](https://www.treinaweb.com.br/direto-ao-ponto) - [ Planos ](https://www.treinaweb.com.br#assinatura) - [ Depoimentos ](https://www.treinaweb.com.br#depoimentos) - [ Comunidade ](https://www.treinaweb.com.br#comunidade) - [ Corpo docente ](https://www.treinaweb.com.br#docente) ## A empresa - [ Sobre a TreinaWeb ](https://www.treinaweb.com.br#sobre) - [ Perguntas frequentes ](https://www.treinaweb.com.br#faq) - [ Vantagens de estudar na TreinaWeb ](https://www.treinaweb.com.br/vantagens-de-estudar-na-treinaweb) - [ Cursos para empresas ](https://www.treinaweb.com.br/empresas) - [ Sugira um novo curso ](https://www.treinaweb.com.br/sugerir-curso) - [ Trabalhe conosco ](https://www.treinaweb.com.br/trabalhe-conosco) - [ Artigos ](https://www.treinaweb.com.br/blog) - [ Desenvolvedores e agentes ](https://www.treinaweb.com.br/developers) - [ Contato ](https://www.treinaweb.com.br/contato) - [ Política de privacidade ](https://www.treinaweb.com.br/politica-de-privacidade) - [ Termos de uso ](https://www.treinaweb.com.br/termos-de-uso) ## Baixe nosso aplicativo [ Disponível na **App Store** ](https://apps.apple.com/us/app/treinaweb/id1322729447) [ Disponível no **Google Play** ](https://play.google.com/store/apps/details?id=br.com.treinaweb.mobile) Av. Paulista, 1765, Conj 71 e 72 · Bela Vista · São Paulo · SP · 01311-200 © 2004 – 2026 TreinaWeb Tecnologia LTDA · CNPJ 06.156.637/0001-58