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

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

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

49
documentation nant web-services wsdl

10 ответов

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

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

и закончил настройку WSDL viewer на мой по необходимости.

19

использовать http://code.google.com/p/wsdl-viewer/ и xsltproc cygwin

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

работает

8

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

8

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

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

6

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

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

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

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

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

5

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

2

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

2

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

-Брайан

1

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

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

0

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

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

0