Desativando a Geração de Documentos WADL para Solicitações HTTP OPTIONS

Um desenvolvedor pode escolher não expor um documento Web Application Description Language (WADL) para um recurso, de modo que eles não exponham informações sobre o serviço. As informações sobre o serviço podem ser melhor obtidas por meio de um documento fornecido pelo desenvolvedor fora do serviço.

Sobre Esta Tarefa

Por padrão, um documento WADL pode ser solicitado para um determinado recurso ao chamar uma solicitação HTTP OPTIONS para qualquer URL de Java™ API para RESTful Web Services (JAX-RS). É possível emitir uma solicitação OPTIONS com a maioria dos clientes HTTP. Entretanto, se não gostar desse comportamento e desejar retornar apenas um documento vazio para qualquer uma das solicitações OPTIONS por padrão, é possível desativar a geração WADL padrão para seu aplicativo.

No seguinte exemplo, é possível desativar a geração WADL padrão para seu aplicativo.

Procedimento

  1. Crie um arquivo de propriedades que contenha as propriedades customizadas para o aplicativo. O exemplo a seguir ilustra um arquivo de propriedades simples:
    org.apache.wink.server.options.handler=none
  2. Coloque o arquivo de propriedades em seu aplicativo.
  3. Use o parâmetro de inicialização propertiesLocation no arquivo web.xml. O exemplo a seguir ilustra um arquivo web.xml com o parâmetro de inicialização propertiesLocation.
    <?xml version="1.0" encoding="UTF-8"?>
    
    <web-app xmlns="http://java.sun.com/xml/ns/j2ee" xmlns:xsi="http://www.w3.org/2001/
    XMLSchema-instance"
        xsi:schemaLocation="http://java.sun.com/xml/ns/j2ee http://java.sun.com/xml/ns/
    j2ee/web-app_3_0.xsd"
        version="3.0">
        <servlet>
            <servlet-name>javax.ws.rs.core.Application</servlet-name>
            <load-on-startup>1</load-on-startup>
            <init-param>
                <param-name>propertiesLocation</param-name>
                <param-value>path/to/file.properties</param-value>
            </init-param>
        </servlet>
        <servlet-mapping>
            <servlet-name>javax.ws.rs.core.Application</servlet-name>
            <url-pattern>/*</url-pattern>
        </servlet-mapping>
    </web-app>

Resultados

A geração WADL padrão foi desativada para seu aplicativo.


Ícone que indica o tipo de tópico Tópico de Tarefa



Ícone de registro de data e hora Última atualização: last_date
http://www14.software.ibm.com/webapp/wsbroker/redirect?version=cord&product=was-nd-mp&topic=twbs_jaxrs_wadl_http_options
Nome do arquivo: twbs_jaxrs_wadl_http_options.html