Ajouter un commentaire avec méthode Jersey

StackOverflow https://stackoverflow.com/questions/2253813

  •  20-09-2019
  •  | 
  •  

Question

Nous utilisons Jersey pour notre webservice et ça a été une grande et simple. Est-il possible d'ajouter un petit commentaire de description dans une définition de méthode (en utilisant peut-être une annotation comme @description): 

@GET
@Path("/schema/classes/")
@Produces( { APPLICATION_RDF, TEXT_N3, APPLICATION_JSON })
@Description("Lists all ontology classes")
public Response getClasses() throws JobOntoException {
  ...
}

Et dans le WADL qui donnerait quelque chose comme: 

<application>
 <doc jersey:generatedBy="Jersey: 1.1.5 01/20/2010 03:55 PM"/>
  <resources base="http://localhost:9998/">
   <resource path="/jobonto">
    <resource path="/schema/classes/">
     <method name="GET" id="getClasses">
      **<description>"Lists all ontology classes"</description>**
      <response> 
       <representation mediaType="application/rdf+xml"/>
       <representation mediaType="text/rdf+n3"/>
       <representation mediaType="application/json"/>
      </response>
     </method>
    </resource>
    ...

Merci, Renaud

Était-ce utile?

La solution

Vous devriez essayer étendre le WadlGeneratorConfig .

Autres conseils

Voici une idée encore meilleure. Mettez la description dans la représentation que vous utilisez pour créer un lien vers cette ressource.

Quel type de média utilisez-vous pour la représentation à la racine de votre service? Xhtml peut être très utile pour cela, car il est facile à analyser, a un support existant pour les liens et rend bien dans un navigateur.

Renaud,

vous utilisez le WADL pour fournir une description de service au développeur du client?

Si oui, s'il vous plaît pas que ce n'est pas RESTful car elle viole la contrainte hypermédia. WADL exprime l'information qu'un développeur client ne doit pas compter. WADL contient essentiellement des informations sur les transitions disponibles et la contrainte hypermédia nécessite de telles informations à découvrir lors de l'exécution, de ne pas être connu au moment de la conception.

Ainsi, en utilisant leur temps d'exécution WADL dans le sens d'une forme est très bien [1] parce que vous pouvez changer le WADL sans casser des clients.

[1] Bien que le style est discutable - personnellement, je préfère concevoir les types de médias spécifiques de domaine

Jan

Licencié sous: CC-BY-SA avec attribution
Non affilié à StackOverflow
scroll top