Создание HTML-документации из WSDL

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

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

Ответы

Ответ 1

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

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

и закончил настройку средства просмотра WSDL на мои нужды.

Ответ 2

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

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

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

Ответ 3

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

Ответ 4

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

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

Ответ 5

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

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

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

ОСНОВНЫЕ ХАРАКТЕРИСТИКИ

  • Генерация документа с одним фреймом (Javadoc-like) HTML с помощью любого количества файлов WSDL/XSD. (Если у вас слишком много входных файлов, вы можете выбрать их все, используя шаблон Ant-like pathname).
  • Обработка любого количества 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 с поддержкой всех графических гиперссылок.
  • Документирование всех межсоединений между определениями 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/

Ответ 6

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

Ответ 7

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

Ответ 8

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

-Bryan

Ответ 9

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

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

Ответ 10

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

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