Criando um serviço da web JAX-RS

Antes de Iniciar

Para implementar o serviço da web, é necessário ter um servidor que tenha o suporte de JVM do Java™ 5.0 ou mais recente definido e iniciado. Isto inclui:
  • WebSphere Application Server v7.0 ou v8.0, selecionando para instalar o Feature Pack for Web 2.0 AND MOBILE e as ferramentas para desenvolvimento do WebSphere Application Server
Por padrão, um servidor é criado para você ao instalar o WebSphere Application Server. Esse servidor pode ser visto na visualização Servidores.

Caso escolha implementar em um servidor diferente do WebSphere Application Server, não é possível usar a biblioteca IBM® JAX-RS e deve-se instalar e configurar suas próprias bibliotecas JAX-RS por meio da página Aspectos do projeto > Preferências do JAX-RS.

Para obter informações detalhadas sobre como usar os serviços da web JAX-RS no WebSphere Application Server, consulte: Centro de informações do WebSphere Application Server

Criar um Projeto da Web Ativado para JAX-RS

Sobre Esta Tarefa

O serviço da web JAX-RS precisa residir em um projeto com o aspecto JAX-RS ativado.
Restrição: [Liberty] Para usar as APIs do JAX-RS 2.0, crie uma Biblioteca de usuário e inclua o com.ibm.ws.javaee.jaxrs.2.0_1.0.0.jar que está na pasta dev/api/spec do ambiente de tempo de execução do Liberty. Mova essa Biblioteca de usuário antes do contêiner do caminho de classe do servidor Liberty no caminho de construção Java do projeto.

O [WebSphere Application Server tradicional] WebSphere Application Server tradicional V9 suporta JAX-RS 1.1 e 2.0. A versão do JAX-RS utilizada no projeto deve corresponder à versão do JAX-RS utilizada na instalação do WebSphere Application Server tradicional V9. Se essas versões não corresponderem, as ferramentas exibirão um aviso quando o projeto for implementado no servidor. Ao criar um projeto JAX-RS sem especificar um nível de máscara, as ferramentas utilizarão o JAX-RS 2.0 por padrão.

[WebSphere Application Server tradicional] Ao incluir um módulo JAX-RS 1.1 em um projeto da web, as ferramentas incluem os seguintes arquivos no contêiner do caminho de classe:
com.ibm.ws.jaxrs.jar
com.ibm.ws.prereq.jaxrs.jar
javax.j2ee.jaxrs.jar
[WebSphere Application Server tradicional] Ao incluir um módulo JAX-RS 2.0 em um projeto da web, as ferramentas incluem os seguintes arquivos no contêiner do caminho de classe:
com.ibm.ws.jaxrs20.jar
com.ibm.ws.prereq.jaxrs20.jar
javax.ws.rs-api-2.0.jar

Procedimento

  1. Na perspectiva Java EE, clique com o botão direito do mouse em seu projeto do aplicativo corporativo e selecione Novo > Projeto da Web para abrir o assistente de projeto da web.
  2. No campo Nome, digite um nome para seu novo projeto da web.
  3. Na seção Modelos de Projeto, selecione o tipo de modelo da web que deseja usar: selecione Simples para criar um projeto da web simples.
  4. Na seção Modelo de programação, selecione o modelo de programação que deseja usar: selecione Modelo de Programação Java EE. Clique em Avançar para configurar seu novo projeto da web.
  5. Na página de implementação, na lista de opções de configuração disponíveis, clique em Implementação para abrir a página de configuração Implementação.
    • É possível alterar o Tempo de Execução de Destino ao selecionar outro tempo de execução a partir de uma caixa suspensa. Clique em Alterar recursos para abrir a janela Aspectos do projeto. Na página Aspectos do Projeto, selecione JAX-RS (Serviços da Web REST) e clique em OK.
    • Clique em Incluir suporte para as ligações e extensões do WebSphere ou desmarque esse campo.
    • No campo Versão do módulo da web, selecione a versão do módulo da web que deseja usar.
    • No campo Associação do EAR, clique em Incluir projeto em um EAR se desejar incluir a associação do EAR ou desmarque esse campo se não desejar incluir o projeto da web em um arquivo EAR.
    • No campo Nome do Projeto do EAR, o nome do seu arquivo EAR existente é exibido. É possível clicar em Procurar para selecionar um arquivo EAR diferente.
    Nota: A opção de implementação não estará disponível se você tiver selecionado o modelo de programação Apenas lado do cliente para seu novo projeto da web.
  6. Na lista de opções de configuração disponíveis, clique em Serviços REST.
    1. No campo Biblioteca de Implementação JAX-RS, selecione a biblioteca para sua versão do servidor, por exemplo, Biblioteca JAX-RS do IBM WebSphere Application Server v8.0 ou Biblioteca JAX-RS do IBM WebSphere Application Server v8.5.
      Saiba mais sobre bibliotecas: As bibliotecas JAX-RS para cada WebSphere Test Environment que você instalou serão listadas nessa caixa suspensa. Se você desejar usar uma biblioteca não WebSphere, ela poderá ser importada usando a página de preferências de Bibliotecas de Usuário. Se você selecionar Biblioteca de Usuário, será possível ativar a página Bibliotecas de Usuário e incluir uma biblioteca. Assim que um projeto tiver sido criado, é possível alterar a biblioteca clicando com o botão direito do mouse em seu projeto e selecionando Preferências > Aspectos do Projeto > JAX-RS. Também é possível selecionar para que o assistente não configure a biblioteca, neste caso, você deve configurar o caminho de classe manualmente.
    2. Se você estiver usando uma versão do WebSphere Application Server anterior à v8, marque Incluir biblioteca com este aplicativo e selecione para incluí-la como uma Biblioteca compartilhada. Isso inclui os jars do JAX-RS no caminho de classe, bem como inclui uma entrada de Biblioteca Compartilhada no EAR aprimorado.
    3. Atualizar Descritor de Implementação é selecionado por padrão porque será necessário usar um web.xml para configurar as restrições de segurança e outros comportamentos. Um web.xml será gerado e atualizado com as informações do servlet JAX-RS mesmo se você tiver selecionado não gerar um descritor de implementação anteriormente no assistente. Esta opção está disponível apenas quando o aspecto Módulos da Web selecionado é v3.0 ou mais recente.
    4. Se você escolheu atualizar o descritor de implementação, poderá alterar o nome do servlet e o nome de classe do servlet e alterar os padrões de mapeamento de URL.
  7. Na lista de opções de configuração disponíveis, clique em Java para abrir a página de configuração Java.
    • No campo Pastas de Origens no Caminho de Construção, aceite o diretório src padrão ou clique em Incluir Pasta, Editar... ou Remover para especificar uma pasta para seus arquivos de origem.
    • No campo Pasta de Saída Padrão:, especifique uma pasta para seus arquivos de saída ou aceite o valor padrão (WebContent\WEB-INF\classes).
  8. Na lista de opções de configuração disponíveis, clique em Módulo da web. Na página Configuração do módulo da web:
    • No campo Raiz de Contexto, digite o nome de sua raiz de projeto da web ou aceite o padrão (que é o nome de seu projeto da web).
    • No campo Diretório de conteúdo, digite o nome do seu diretório de conteúdo ou aceite o padrão (WebContent).
    • Selecione Gerar descritor de implementação web.xml se desejar criar um descritor de implementação. Também é possível incluir um descritor de implementação no seu módulo da web posteriormente.
  9. Clique em Concluir.

Criar um Serviço da Web JAX-RS

Procedimento

  1. Em seu projeto da web, crie um pacote (clique com o botão direito do mouse em Recursos Java > src e selecione Novo > Pacote). Importe as classes do serviço da web para o pacote.
  2. Abra WebContent/WEB-INF/web.xml. Na visualização Design, selecione o Servlet JAX-RS Servlet e clique em Incluir e inclua um parâmetro de Inicialização no servlet JAX-RS, deixando os campos de nome e valor vazios. Salve o web.xml ignorando quaisquer erros que possam ser exibidos.
  3. Na visualização Marcadores, selecione o erro do web.xml sobre o param-name, clique com o botão direito do mouse e selecione Correção Rápida. Procure o aplicativo e selecione.
  4. Inclua o EAR que contém o projeto JAX-RS no servidor e inicie o servidor.

Resultados

Cada aplicativo da web deve ter uma raiz de contexto para o aplicativo da web implementar com êxito. Uma raiz de contexto para cada módulo de Web é definido no descritor de implementação do aplicativo durante a montagem do aplicativo ou durante a implementação do aplicativo. A raiz de contexto é combinada com o mapeamento de servlet definido a partir do arquivo WAR para compor a URL integral que os usuários digitam para acessar o servlet. A raiz de contexto para cada aplicativo da web implementado deve ser exclusiva no servidor. A raiz de contexto também pode estar vazia.

Por exemplo, se um aplicativo da web usou uma raiz de contexto de sample/application/, a URL de solicitação de aplicativo da web iniciará com http://<nome_do_host>:<porta>/sample/application/. O padrão da URL de um servlet é anexado à raiz de contexto do aplicativo da web. Por exemplo, se a raiz de contexto for sample/application/ e o mapeamento de URL do servlet for rest/api/*, o URI base para o aplicativo da web JAX-RS será http://<nome_do_host>:<porta>/sample/application/rest/api.

Editando um Projeto JAX-RS

Depois que você tiver criado um serviço da web JAX-RS, é possível editá-lo clicando com o botão direito do mouse no projeto e selecionando Propriedades > Aspectos do Projeto > JAX-RS. Nessa página, é possível alterar:
  • Tipo de Biblioteca
  • Nome de servlet JAX-RS
  • Nome de classe de servlet JAX-RS
  • Padrões de mapeamento de URL
Por exemplo, se você migrar seu projeto para um servidor diferente, será possível alterar o provedor de biblioteca para um suportado pelo novo servidor.
Icon that indicates the type of topic Task topic
Timestamp icon Last updated: last_date

File name: tjaxrswebservcreate.html