Generowanie dokumentacji HTML z WSDL [zamknięty]

Jakie są wasze podejścia do generowania jakiejś dokumentacji czytelnej dla człowieka z WSDLs? W przeszłości używałem WSDL viewer (by Tomi Vanek) (Zobacz mój wpis na blogu o integracji z NAnt ) i jestem zadowolony z wyników, ale jestem zainteresowany ewentualnymi alternatywami.

Słyszałem też o x3sp, ale nie próbowałem.

Author: Igor Brejc, 2009-03-26
Source

10 answers

Próbowałem kilku alternatyw

  • TechWriter for Web Services : naprawdę potężny, ale wyjście HTML było (Zobacz komentarze) multi-file. Ponadto komentarze wskazują, że jest wycofany, ale tak już nie jest.
  • edytor XML: nie przetwarza wbudowanego schematu.
  • Altova XML Spy : nie przetwarza anonimowych typów.

I skończyło się na dostosowaniu WSDL viewer do moich potrzeb.

 19
Author: fglez,
Warning: date(): Invalid date.timezone value 'Europe/Kyiv', we selected the timezone 'UTC' for now. in /var/www/agent_stack/data/www/doraprojects.net/template/agent.layouts/content.php on line 54
2017-10-11 08:57:06

Użyj http://code.google.com/p/wsdl-viewer / i xsltproc Cygwina 

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

Działa jak urok

 8
Author: Tomáš Fejfar,
Warning: date(): Invalid date.timezone value 'Europe/Kyiv', we selected the timezone 'UTC' for now. in /var/www/agent_stack/data/www/doraprojects.net/template/agent.layouts/content.php on line 54
2011-02-25 13:55:37

Tak, jest Nowy: wsdl2html . Skupia się na prośbie/odpowiedzi i usuwa informacje, które ludzie nie dbają.

 8
Author: Jian Chen,
Warning: date(): Invalid date.timezone value 'Europe/Kyiv', we selected the timezone 'UTC' for now. in /var/www/agent_stack/data/www/doraprojects.net/template/agent.layouts/content.php on line 54
2015-12-21 09:26:45

Nie ma go tutaj, ale SoapUI ma przydatny generator dokumentacji wsdl.

Kliknij prawym przyciskiem myszy na swoim projekcie i wybierz " Generuj dokumentację."

 6
Author: Halfstop,
Warning: date(): Invalid date.timezone value 'Europe/Kyiv', we selected the timezone 'UTC' for now. in /var/www/agent_stack/data/www/doraprojects.net/template/agent.layouts/content.php on line 54
2016-07-14 09:23:43

Teraz jest jeszcze jedno narzędzie do tego, o nazwie " DocFlex / XML WSDLDoc ".

Jest to nowy generator dokumentacji WSDL / XSD, który pozwoli Ci udokumentować dowolną liczbę plików WSDL i XML schema (XSD) oraz dowolne połączenia między nimi.

Istnieje również opcja automatycznego włączania diagramów XSD generowanych przez Altova XMLSpy lub Oxygen XML. W praktyce każdy z nich może być używany jako dynamicznie połączony silnik diagramowania.

Klucz Cechy

  • generowanie pojedynczej ramki (podobnej do Javadoc) dokumentacji HTML przez dowolną liczbę WSDL/XSD plików razem. (Jeśli masz zbyt wiele plików wejściowych, możesz wybrać wszystkie za pomocą Ant-podobnego wzorca ścieżki).
  • przetwarzanie dowolnej liczby schematów XML (wraz z WSDL) w tym:
    • w postaci oddzielnych plików XSD
      • XML Schematy wbudowane w WSDL (w elemencie <wsdl:definitons>/<wsdl:types>)
  • przetwarzanie dowolnych odwołujących się do plików WSDL i schematów XML, w szczególności:
    • poprawne przetwarzanie wszystkich <wsdl:import>, <xs:import>, <xs:include>, <xs:redefine> elementy znalezione we wszystkich zaangażowanych plikach WSDL / XSD.
    • automatyczne ładowanie i przetwarzanie (tj. włączenie do zakresu dokumentacji) wszystkich bezpośrednio/pośrednio odwołujących się plików WSDL/XSD.
  • zaawansowane dokumentowanie komponentów XSD (dokumentacja XML schema):
    • Obsługa dowolnego schematu XML wzory.
    • możliwość automatycznego włączenia diagramów XSD wygenerowanych przez XMLSpy lub XML, z obsługą wszystkich hiperłączy diagramu.
  • dokumentowanie wszystkich połączeń pomiędzy definicjami WSDL a komponentami XSD:
    • hiperłącza od wiadomości WSDL do szczegółów elementów / typów XSD opisujących dane wiadomości.
    • w XSD element / type details, lista wszystkich definicji WSDL gdzie są używane.
    • skopiuj adnotacje elementów/typów XSD do dokumentacji tych komunikatów WSDL (a nawet operacji), gdzie są one używane.
  • możliwość nieograniczonej personalizacji. WSDLDoc jest w rzeczywistości zestawem szablonów dla DocFlex/XML , systemu oprogramowania do tworzenia i wykonywania wysokiej wydajności dokumentacji i generatorów raportów z dowolnych danych przechowywanych w plikach XML.

    • Przykład

    Tutaj jest demo takiej dokumentacji (została wygenerowana przez jeden plik źródłowy: http://developer.ebay.com/webservices/latest/ebaySvc.wsdl):

    eBay Trading API-dokumentacja WSDL

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

    Linki

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

     5
    Author: Leonid Rudy,
    Warning: date(): Invalid date.timezone value 'Europe/Kyiv', we selected the timezone 'UTC' for now. in /var/www/agent_stack/data/www/doraprojects.net/template/agent.layouts/content.php on line 54
    2014-07-09 11:11:50

    XMLSpy Altova generuje dokumentację HTML z WSDL ... ale nie jest za darmo;)

     2
    Author: Alexandre Victoor,
    Warning: date(): Invalid date.timezone value 'Europe/Kyiv', we selected the timezone 'UTC' for now. in /var/www/agent_stack/data/www/doraprojects.net/template/agent.layouts/content.php on line 54
    2009-04-15 21:45:54

    Właśnie odkryłem, że Notepad++ z zainstalowaną Wtyczką XML Tools może również wykonywać transformacje xsl. Jeśli podasz mu wsdl-viewer.wspomniany wcześniej XSL i plik wsdl, w rezultacie otrzymasz ładnie sformatowany html.

     2
    Author: Patrick Koorevaar,
    Warning: date(): Invalid date.timezone value 'Europe/Kyiv', we selected the timezone 'UTC' for now. in /var/www/agent_stack/data/www/doraprojects.net/template/agent.layouts/content.php on line 54
    2014-02-03 14:22:04

    Wiem, że to metoda dokumentacji biednego człowieka, ale użyłem otwierania wsdl XSD w visual studio i robienia snag-drukuje to z komentarzami i strzałkami dodanymi dla jasności i wydaje się, że Klientowi się to podobało bez konieczności używania innego narzędzia. Możesz też tego nie mieć, ale możesz użyć wersji z darmowej subskrypcji VPC lub MSDN użyłem również edytora schematu BizTalk do przeglądania XSD i dokumentowania go stamtąd za pomocą snag-it lub innej aplikacji do przechwytywania ekranu. Spróbowałbym i wykorzystaj to, co masz!

    -Bryan

     1
    Author: Bryan Corazza,
    Warning: date(): Invalid date.timezone value 'Europe/Kyiv', we selected the timezone 'UTC' for now. in /var/www/agent_stack/data/www/doraprojects.net/template/agent.layouts/content.php on line 54
    2009-03-27 00:18:22

    Możesz użyć "wsimport", który jest częścią JDK i uruchomić Javadoc na wygenerowanych plikach. Zakładając, że umieściłeś w adnotacjach, umieścisz je jako część dokumentacji.

    Innym narzędziem byłby Rational Application Developer, który pozwala kliknąć prawym przyciskiem myszy i wygenerować dokumentację HTML z ładnymi hiperłączami.

     0
    Author: Archimedes Trajano,
    Warning: date(): Invalid date.timezone value 'Europe/Kyiv', we selected the timezone 'UTC' for now. in /var/www/agent_stack/data/www/doraprojects.net/template/agent.layouts/content.php on line 54
    2010-08-04 16:11:17

    Możesz użyć iDocIt! aby udokumentować WSDL i wyeksportować dokumentację do HTML. Jest to wtyczka open source Eclipse do pobrania tutaj .

    Zapewnia nowe podejście do tworzenia dokumentacji z siatkami tematycznymi i rolami tematycznymi, ale nie musisz z nich korzystać. Dokumentacje można tworzyć w formie zwykłego tekstu.

     0
    Author: Dirk,
    Warning: date(): Invalid date.timezone value 'Europe/Kyiv', we selected the timezone 'UTC' for now. in /var/www/agent_stack/data/www/doraprojects.net/template/agent.layouts/content.php on line 54
    2012-11-12 05:06:31