Inhabilitar la generación de documentos WADL para las solicitudes OPTIONS de HTTP

Un desarrollador puede optar por no exponer un documento WADL (Web Application Description Language) de un recurso, con lo que no expone información sobre ese servicio. En ese caso, se puede obtener información sobre el servicio a través de un documento que proporcione el desarrollador de forma externa al servicio.

Acerca de esta tarea

De forma predeterminada, se puede solicitar un documento WADL para un recurso determinado invocando una solicitud OPTIONS HTTP para cualquier URL de API de Java™ para RESTful Web Services (JAX-RS). Puede emitir una petición OPTIONS con la mayoría de los clientes HTTP. Sin embargo, si no le gusta este comportamiento y desea devolver simplemente un documento vacío para cualquier petición de OPTIONS de forma predeterminada, puede inhabilitar la opción predeterminada de generar WADL en su aplicación.

En el ejemplo siguiente, puede inhabilitar el valor predeterminado de generación de WADL en su aplicación.

Procedimiento

  1. Crear un archivo de propiedades que contenga las propiedades personalizadas para la aplicación. En el ejemplo siguiente se muestra un archivo de propiedades simple:
    org.apache.wink.server.options.handler=none
  2. Ponga el archivo de propiedades en la aplicación.
  3. Utilice el parámetro de inicialización propertiesLocation del archivo web.xml. En el ejemplo siguiente se muestra un archivo web.xml con el parámetro de inicialización 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

Ha inhabilitado la opción predeterminada de generación de WADL en su aplicación.


Icon that indicates the type of topic Task topic



Timestamp icon Last updated: last_date
http://www14.software.ibm.com/webapp/wsbroker/redirect?version=cord&product=was-nd-mp&topic=twbs_jaxrs_wadl_http_options
File name: twbs_jaxrs_wadl_http_options.html