Désactivation de la génération de documents WADL pour les demandes HTTP OPTIONS

Un développeur peut décider de ne pas exposer un document WADL (Web Application Description Language) pour une ressource pour ne pas exposer they do des informations sur le service. Il est préférable d'obtenir les informations sur le service via un document fourni par le développeur en-dehors du service.

Pourquoi et quand exécuter cette tâche

Par défaut, un document WADL peut être demandé pour une ressource particulière en appelant une demande HTTP OPTIONS pour toute URL Java™ API for RESTful Web Services (JAX-RS). Vous pouvez émettre une demande OPTIONS avec la plupart des clients HTTP. Toutefois, si vous n'aimez pas ce comportement et souhaitez revenir à un document vide pour toute demande OPTIONS par défaut, vous pouvez désactiver la génération WADL par défaut pour votre application.

Dans l'exemple suivant, vous pouvez désactiver la génération WADL par défaut pour votre application.

Procédure

  1. Créez un fichier de propriétés qui contient les propriétés personnalisées pour l'application. L'exemple suivant illustre un fichier de propriétés unique :
    org.apache.wink.server.options.handler=none
  2. Placez le fichier de propriétés dans votre application.
  3. Utilisez le paramètre d'initialisation propertiesLocation dans le fichier web.xml. L'exemple suivant illustre un fichier web.xml avec le paramètre d'initialisation 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>

Résultats

Vous avez désactivé la génération WADL par défaut pour votre application.


Icône indiquant le type de rubrique Rubrique de tâche



Icône d'horodatage Dernière mise à jour: last_date
http://www14.software.ibm.com/webapp/wsbroker/redirect?version=cord&product=was-nd-mp&topic=twbs_jaxrs_wadl_http_options
Nom du fichier : twbs_jaxrs_wadl_http_options.html