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

Question

Каковы ваши подходы к созданию какой-либо учебной документации для людей из WSDL? В прошлом я использовал WSDL viewer (от Tomi Vanek) (см. my blog post about integrating it into NAnt), и я доволен результатами, но меня интересуют любые возможные альтернативы.

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

Answer 1

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

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

и закончил настройку просмотра WSDL для моих нужд.

Answer 2

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

-Bryan

Answer 3

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

Answer 4

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

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

Answer 5

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

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

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

Answer 6

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

Answer 7

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

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

Answer 8

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

Answer 9

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

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

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

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

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

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

ССЫЛКИ

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

Answer 10

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

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