2015-07-30 2 views
1

Я разработал некоторые веб-службы JAX-WS, используя реализацию Metro.Как документировать приложение JAX-WS на основе метро

Теперь то, что я хочу добавить к этим веб-сервисам, - это документация. Metro, сам, генерирует вам «простой» doc html-файл, который включает в себя расположение WSDL и нечто большее.

Итак, я занимаюсь некоторыми исследованиями, и я нашел Enunciate, что поможет вам создать документацию и клиентские приложения ваших веб-сервисов на нескольких языках программирования (что полезно для повторного использования). Но пока меня интересует только генерация документации. Я вижу, что поддерживает Apache CXF, JAX-WS, JAX-RS, но не поддерживает Metro, или мне не удалось найти плагин.

Итак, смогу ли я создавать документацию для своих веб-сервисов?

Есть ли другой инструмент для создания документации по приложению JAX-WS (на основе метро)?

Спасибо заранее

+1

Просто заметил этот интересный вопрос. Что вы подразумеваете под «простым doc html-файлом», который генерирует Metro? Существует аккуратный инструмент, который генерирует документацию из WSDL, и мы использовали его в течение многих лет, я объясню это в отдельном ответе, если это то, что вы ищете. –

+0

@ MiljenMikic metro создает простую страницу документации html в корне, где отображаются имя службы, служебный порт, местоположение wsdl, местоположение и класс реализации. Кстати, я нашел инструмент, который поможет вам документировать много приложений: http://enunciate.webcohesion.com/ – russellhoff

ответ

1

излагают, что вы нашли это действительно мощный, выходит за рамки не только документирование службы. Однако, если вы просто ищете документацию, есть простой инструмент, который наша команда использует в течение довольно долгого времени - WSDL viewer Томи Ванека.

Он очень прост в использовании, просто с подключением уже предоставили файл .xsl в дополнение к существующему .wsdl файла, повысить .wsdl файл с линией

<?xml-stylesheet type="text/xsl" href="wsdl-viewer.xsl"?> 

, а затем открыть файл .wsdl в браузере. Вы увидите что-то вроде этого: (только подготовили демо :))

enter image description here

Некоторые замечания:

  • добавления документации .wsdl файл выполняется с <wsdl:documentation> тегов
  • вы будете способный открывать такой файл .wsdl во всех современных браузерах, кроме Chrome, из-за того, что Chrome blocks XSL transform on a local file

HTH.

+0

Спасибо за помощь. Хорошо знать существование такого инструмента, как ваш :) – russellhoff

+0

@ russellhoff Добро пожаловать! Тем не менее, я не беру на себя ответственность за этот инструмент, Tomi Vanek является автором, мы только что использовали его, поэтому я подумал, что было бы неплохо поделиться. –

Смежные вопросы