Aggiungi commento metodo con Jersey

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

  •  20-09-2019
  •  | 
  •  

Domanda

Stiamo usando Jersey per il nostro webservice ed è stato grande e diretto. C'è un modo per aggiungere una piccola descrizione commento all'interno di una definizione di metodo (forse usando un'annotazione simile @Description): 

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

E nel WADL che possa dare qualcosa come: 

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

Grazie, Renaud

È stato utile?

Soluzione

Si dovrebbe provare a estendere il WadlGeneratorConfig .

Altri suggerimenti

Qui è un'idea ancora migliore. Mettere la descrizione nella rappresentazione che si utilizza per creare un collegamento a questa risorsa.

Che tipo di supporto stai usando per la rappresentazione alla radice del vostro servizio? Xhtml può essere molto utile per questo, perché è facile da analizzare, ha il supporto esistente per i collegamenti e rende bene in un browser.

Renaud,

Si sta utilizzando il WADL di fornire una descrizione del servizio per lo sviluppatore cliente?

Se è così, non che questo non è riposante in quanto viola il vincolo ipermedia. WADL esprime le informazioni che uno sviluppatore cliente non deve fare affidamento su. WADL contiene essenzialmente informazioni sulle transizioni disponibili e il vincolo ipermedia richiede tali informazioni da scoprire in fase di esecuzione, di non essere conosciuto in fase di progettazione.

In questo modo, utilizzando WADL annuncio runtime nel senso di una forma va bene [1], perché si può cambiare il WADL senza rompere qualsiasi client.

[1] Anche se lo stile è discutibile - personalmente, avrei preferito progettare tipi specifici di supporti dominio

Jan

Autorizzato sotto: CC-BY-SA insieme a attribuzione
Non affiliato a StackOverflow
scroll top