Добавить комментарий метода с Джерси - PullRequest
Новая
       15

Добавить комментарий метода с Джерси

2 голосов
/ 12 февраля 2010

Мы использовали Джерси для нашего веб-сервиса, и это было здорово и просто. Есть ли способ добавить небольшой комментарий к описанию в определении метода (возможно, используя аннотацию типа @Description): 

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

А в WADL это даст что-то вроде: 

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

Спасибо, Рено

Ответы [ 3 ]

2 голосов
/ 05 марта 2010

Вы должны попробовать расширить WadlGeneratorConfig .

0 голосов
/ 13 февраля 2010

Renaud,

используете ли вы WADL для предоставления описания услуги разработчику клиента?

Если это так, пожалуйста, обратите внимание, что это не RESTful, поскольку оно нарушает ограничение гипермедиа. WADL выражает информацию, на которую клиентский разработчик не должен полагаться. WADL по существу содержит информацию о доступных переходах, а ограничение гипермедиа требует, чтобы такая информация была обнаружена во время выполнения, а не известна во время разработки.

Таким образом, использование WADL-рекламы в смысле формы - это нормально [1], поскольку вы можете изменить WADL, не ломая клиентов.

[1] Несмотря на то, что стиль является дискуссионным - лично я бы предпочел разрабатывать специфичные для предметной области типы медиа

Jan

0 голосов
/ 12 февраля 2010

Вот еще лучшая идея. Поместите описание в представление, которое вы используете для ссылки на этот ресурс.

Какой тип носителя вы используете для представления в корне вашей службы? Xhtml может быть очень полезен для этого, потому что он легко разбирается, имеет существующую поддержку ссылок и хорошо отрисовывается в браузере.

...