Использование Enunciate with Grails - PullRequest
Новая
       16

Использование Enunciate with Grails

2 голосов
/ 04 августа 2011

Я создаю веб-API, RESTful способом.Grails, конечно, имеет хорошую поддержку для создания веб-сервисов REST. Enunciate претендует на помощь в части API, где важны такие вещи, как документация, клиентские библиотеки и т. Д.

Цель этого поста - предложить опыт использования Enunciate with Grails или идеи о том, как это можно сделать.

Существует две основные проблемы их совместного использования:

  1. Enunciate работает с JAX-RS, а не с собственной реализацией REST от Grails.К счастью, доступен плагин JAX-RS, но я не уверен, сможет ли Enunciate работать с ним.

  2. Доменные классы Grails находятся в Groovy, а Enunciate работает с исходным кодом Java ( пример ).

1 Ответ

1 голос
/ 04 августа 2011

Enunciate работает как с исходным кодом Java, так и скомпилированным байт-кодом Java, чтобы выполнять свою работу.Но если у вас нет исходного кода Java, Enunciate не сможет извлечь что-то из ваших JavaDocs для улучшения сгенерированной документации.Учитывая это, (теоретически) должен быть способ применить Enunciate к скомпилированному байт-коду Groovy, но ваши документы не будут такими богатыми, потому что Enunciate не сможет видеть вашу документацию JavaDoc.Я говорю теоретически, потому что у меня нет никакого личного опыта с этим, и при этом я не знаю, насколько болезненно это осуществить.

Есть открытая проблема в ENUNCIATE-356 , чтобы исследовать этосложность.Обратите внимание, что ENUNCIATE-356 зависит от ENUNCIATE-584 , который вскоре может получить еще большее сцепление с движением от ENUNCIATE-585 при переходе от использования APTвведен в Java 5, устарел в Java 7) для инструмента Javac (представлен в Java 6).Было бы интересно узнать, поддерживает ли инструмент Javac языки, отличные от Java, и в этом случае мы получим бесплатную поддержку Groovy.

...