it-swarm.xyz

Генерация HTML документации из WSDL

Каковы ваши подходы к созданию какой-либо удобочитаемой документации из WSDL? В прошлом я использовал средство просмотра WSDL (Томи Ванек) (см. мой пост в блоге об интеграции его в NAnt ) и я доволен результатами, но меня интересуют любые возможные альтернативы.

Я также слышал о x3sp , но я не пробовал. 

49
Igor Brejc

Я пробовал несколько альтернатив

  • TechWriter для веб-сервисов : действительно мощный, но вывод HTML был (см. Комментарии) многофайловым. Кроме того, комментарии указывают, что он на пенсии, но это уже не так.
  • <oXygen /> Редактор XML : Он не обрабатывает встроенную схему.
  • Altova XML Spy : Он не обрабатывает анонимные типы.

и в итоге настроил просмотрщик WSDL под мои нужды.

19
fglez

Используйте http://code.google.com/p/wsdl-viewer/ и Cygwin's xsltproc

xsltproc wsdl-viewer.xsl downloaded-wsdl.xml > documetnation.html

Работает как шарм

8
Tomáš Fejfar

Да, есть новый: wsdl2html . Он фокусируется на запросе/ответе и удаляет информацию, которая не волнует людей. 

8
Jian Chen

Это не указано здесь, но SoapUI имеет полезный генератор документации wsdl.

Щелкните правой кнопкой мыши по вашему проекту и выберите «Создать документацию».

6
Halfstop

Теперь для этого есть еще один инструмент, который называется " DocFlex/XML WSDLDoc ". 

Это новый генератор документации WSDL/XSD, который позволит вам документировать любое количество файлов WSDL и XML-схемы (XSD), а также любые взаимосвязи между ними.

Существует также возможность автоматического включения диаграмм XSD, созданных либо Altova XMLSpy, либо Oxygen XML. По сути, любой из них может использоваться в качестве динамически связанного механизма построения диаграмм.

КЛЮЧЕВАЯ ОСОБЕННОСТЬ

  • Генерация однокадровой (Javadoc-подобной) HTML документации из любого количества WSDL/XSD файлов вместе. (Если у вас слишком много входных файлов, вы можете выбрать их все, используя Ant-like pathname pattern).
  • Обработка любого количества XML схем (вместе с WSDL), включая:
    • В виде отдельных файлов XSD
    • XML-схемы, встроенные в WSDL (в элементе <wsdl:definitons>/<wsdl:types>)
  • Обработка любых ссылочных WSDL-файлов и XML-схем, в частности:
    • Корректная обработка всех элементов <wsdl:import>, <xs:import>, <xs:include>, <xs:redefine> во всех задействованных файлах WSDL/XSD.
    • Автоматическая загрузка и обработка (т.е. включение в область документации) всех файлов WSDL/XSD, на которые имеется прямая/косвенная ссылка.
  • Сложное документирование компонентов XSD (документация схемы XML):
    • Поддержка любых шаблонов проектирования XML-схем.
    • Возможность автоматического включения XSD-диаграмм, сгенерированных либо XMLSpy или Oxygen XML , с поддержкой гиперссылок всех диаграмм.
  • Документирование всех interconnections между определениями WSDL и компонентами XSD:
    • Гиперссылки из сообщений WSDL на детали элементов/типов XSD, описывающих данные сообщения.
    • В подробностях элемента/типа XSD - список всех определений WSDL, где они используются.
    • Скопируйте аннотации элементов/типов XSD в документацию тех сообщений WSDL (и даже операций), где они используются.
  • Возможность неограниченного настройки. WSDLDoc - это набор шаблонов для DocFlex/XML , системы программного обеспечения для разработки и выполнения высокопроизводительной документации и генераторов отчетов из любых данных, хранящихся в файлах XML.

ПРИМЕР

Вот демонстрация такой документации (она была сгенерирована одним исходным файлом: http://developer.ebay.com/webservices/latest/ebaySvc.wsdl ):

eBay Trading API - WSDL documentation

Сам HTML: http://www.filigris.com/docflex-xml/wsdldoc/examples/html/ebaySvc/index.html

ССЫЛКИ

http://www.filigris.com/docflex-xml/wsdldoc/ ​​

5
Leonid Rudy

Я только что обнаружил, что Notepad ++ с установленным плагином Xml Tools также может выполнять преобразования xsl. Если вы предоставите ему wsdl-viewer.xsl, упомянутый ранее, и файл wsdl, в результате вы получите красиво отформатированный html.

2
Patrick Koorevaar

XMLSpy от Altova генерирует HTML-документацию из WSDL .__, но она не бесплатна;)

2
Alexandre Victoor

Я знаю этот метод документирования для бедного человека, но я использовал открытие XSD-файла wsdl в визуальной студии и выполнял распечатку этого с комментариями и стрелками для ясности, и нашему клиенту, похоже, понравилось без использования другого инструмента. , У вас также может не быть этого, но вы можете использовать версию из бесплатной подписки VPC или MSDN. Я также использовал редактор схем BizTalk для просмотра XSD, а также документирования его оттуда с помощью snag-it или другого приложения для захвата экрана. Я бы попробовал использовать то, что у тебя есть!

-Bryan

1
Bryan Corazza

Вы можете использовать «wsimport», который является частью JDK, и запустить Javadoc для сгенерированных файлов. Предполагая, что вы добавили аннотации, они будут включены в документацию.

Другим инструментом может быть Rational Application Developer, который позволяет щелкнуть правой кнопкой мыши и сгенерировать HTML-документацию с красивыми гиперссылками.

0
Archimedes Trajano

Вы можете использовать iDocIt! документировать WSDL и затем экспортировать документацию в HTML. Это плагин Eclipse с открытым исходным кодом, загружаемый здесь .

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

0
Dirk