Adicionar comentário do método com Jersey

Question

Usamos Jersey para o nosso serviço da web e tem sido ótimo e direto. Existe uma maneira de adicionar um pequeno comentário de descrição em uma definição de método (talvez usando uma anotação como @Description):

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

E no WADL que daria 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>
    ...

Obrigado, Renaud

Answer 1

Você deve tentar estender o WadlgeneratorConfig.

• Projeto de amostra

Answer 2

Aqui está uma ideia ainda melhor. Coloque a descrição na representação que você usa para vincular a este recurso.

Qual tipo de mídia você está usando para a representação na raiz do seu serviço? O XHTML pode ser muito útil para isso, porque é fácil analisar, possui suporte existente para links e renderiza muito bem em um navegador.

Answer 3

Renaud,

Você está usando o WADL para fornecer uma descrição de serviço ao desenvolvedor do cliente?

Nesse caso, não que isso não seja repousante, pois viola a restrição da hipermídia. O WADL expressa informações em que um desenvolvedor de clientes não deve confiar. O WADL contém essencialmente informações sobre as transições disponíveis e a restrição de hipermídia exige que essas informações sejam descobertas em tempo de execução, para não serem conhecidas no tempo de design.

Assim, o uso do tempo de execução do WADL AD no sentido de um formulário é bom [1] porque você pode alterar o WADL sem quebrar nenhum cliente.

1] Embora o estilo seja discutível - pessoalmente, prefiro projetar tipos de mídia específicos de domínio

Jan