Добавление описания к параметрам веб-сервиса RestEasy? - PullRequest
Новая
       32

Добавление описания к параметрам веб-сервиса RestEasy?

0 голосов
/ 25 сентября 2011

Есть ли способ / аннотация, с помощью которой я могу добавить описание к параметрам веб-службы RestEasy?Я просмотрел api-doc аннотаций, но там ничего не нашел.

Это для того, чтобы добавить описания, чтобы они отражались в документации REST API, которую я приведубыть автоматически генерируемым с использованием какого-либо инструмента.

Пример интерфейса веб-службы: 

@Path("list-all")
@GET
@RBAC(type = { CRUDEnum.READ }, capability = { "PowerUser" })
@ParseContext
@Produces( {
        "application/json",
        "application/xml"})
public net.myapp.services getAllDevices(
        @QueryParam("start") int param0, @QueryParam("limit") int param1);

1 Ответ

1 голос
/ 21 октября 2011

нашёл способ для этого. Нет аннотации REST для добавления описания параметра.

Решением для этого является использование типовой аннотации java-doc.

например. 

/** 
 * @param param0 Paging parameter
 * @param param1 Paging parameter
 * */
@Path("list-all")
@GET
@RBAC(type = { CRUDEnum.READ }, capability = { "PowerUser" })
@ParseContext
@Produces( {
        "application/json",
        "application/xml"})
public net.myapp.services getAllDevices(
        @QueryParam("start") int param0, @QueryParam("limit") int param1);
...