Agregar comentario método con el Jersey

Question

Hemos estado utilizando Jersey por nuestro servicio web y ha sido genial y sencillo. ¿Hay una manera de añadir una descripción pequeña comentario dentro de una definición de método (tal vez utilizando una anotación como @description):

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

Y en el WADL que daría algo como:

<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>
    ...

Gracias, Renaud

Answer 1

Usted debe tratar de extender el WadlGeneratorConfig .

proyecto
• Muestra

Answer 2

Aquí es una idea aún mejor. Ponga la descripción en la representación que se utiliza para vincular a este recurso.

¿Qué tipo de soporte está usando para la representación en la raíz de su servicio? XHTML puede ser muy útil para esto porque es fácil de analizar, tiene soporte para enlaces existentes y hace muy bien en un navegador.

Answer 3

Renaud,

¿Está utilizando el WADL para proporcionar una descripción del servicio al desarrollador del cliente?

Si es así, no es que esto no es relajante ya que viola la restricción hipermedia. WADL expresa la información que un desarrollador cliente no debe confiar. WADL contiene esencialmente información sobre transiciones disponibles y la restricción de hipermedia requiere que dicha información se descubrió en tiempo de ejecución, para no ser conocido en tiempo de diseño.

Por lo tanto, el uso de WADL anuncio de tiempo de ejecución en el sentido de una forma bien es [1], ya que puede cambiar la WADL sin romper ningún cliente.

[1] Aunque el estilo es discutible - personalmente, prefiero diseñar tipos de medios específicos de dominio

Jan