Generar documentación HTML desde WSDL [cerrado]


¿Cuáles son sus enfoques para generar algún tipo de documentación legible por humanos a partir de WSDLs? En el pasado he usado WSDL viewer (por Tomi Vanek) (ver mi entrada de blog sobre integrarlo en NAnt ) y estoy contento con los resultados, pero estoy interesado en cualquier alternativa posible.

También he oído hablar de x3sp, pero no lo he probado.

Author: Igor Brejc, 2009-03-26

10 answers

Probé varias alternativas

Y terminé ajustando el visor WSDL a mis necesidades.

 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/ajaxhispano.com/template/agent.layouts/content.php on line 61
2017-10-11 08:57:06

Use http://code.google.com/p/wsdl-viewer / y xsltproc de cygwin

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

Funciona como un encanto

 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/ajaxhispano.com/template/agent.layouts/content.php on line 61
2011-02-25 13:55:37

Sí, hay una nueva: wsdl2html. Se centra en la solicitud/respuesta y elimina la información que a las personas no les importa.

 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/ajaxhispano.com/template/agent.layouts/content.php on line 61
2015-12-21 09:26:45

No aparece aquí, pero SoapUI tiene un útil generador de documentación wsdl.

Haga clic con el botón derecho en su proyecto y seleccione "Generar documentación"."

 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/ajaxhispano.com/template/agent.layouts/content.php on line 61
2016-07-14 09:23:43

Ahora, hay una herramienta más para esto, llamada "DocFlex/XML WSDLDoc".

Es un nuevo generador de documentación WSDL/XSD que le permitirá documentar cualquier número de archivos WSDL y XML schema (XSD) más cualquier interconexión entre ellos.

También existe la opción de incluir automáticamente diagramas XSD generados por Altova XMLSpy o Oxygen XML. Efectivamente, cualquiera de ellos se puede utilizar como motor de diagramación enlazado dinámicamente.

CLAVE CARACTERÍSTICAS

  • Generación de documentación HTML enmarcada (similar a Javadoc) por cualquier número de archivosWSDL/XSD juntos. (Si tiene demasiados archivos de entrada, puede seleccionarlos todos usando un patrón de ruta similar a Ant).
  • Procesamiento de cualquier número de esquemas XML (junto con WSDL) incluyendo:
    • En forma de archivos XSD separados
    • Esquemas XML incrustados en WSDL (dentro del elemento <wsdl:definitons>/<wsdl:types>)
  • Procesamiento de cualquier referenciado archivos WSDL y esquemas XML, en particular:
    • Correcto procesamiento de todos <wsdl:import>, <xs:import>, <xs:include>, <xs:redefine> elementos encontrados en todos los archivos WSDL/XSD involucrados.
    • Carga y procesamiento automáticos (es decir, inclusión en el ámbito de la documentación) de todos los archivos WSDL/XSD con referencia directa o indirecta.
  • Documentación sofisticada de componentes XSD (documentación de esquema XML):
    • Compatibilidad con cualquier diseño de esquema XML patrón.
    • Posibilidad de incluir automáticamente diagramas XSD generados por XMLSpy o Oxygen XML, con el soporte de todos los hipervínculos de diagrama.
  • Documentación de todas las interconexiones entre las definiciones WSDL y los componentes XSD:
    • Hipervínculos de mensajes WSDL a los detalles de los elementos/tipos XSD que describen los datos del mensaje.
    • En los detalles del elemento/tipo XSD, la lista de todas las definiciones WSDL donde se utilizan.
    • Copie las anotaciones de los elementos/tipos XSD a la documentación de esos mensajes WSDL (e incluso operaciones) donde se utilizan.
  • Posibilidad de personalización ilimitada . WSDLDoc es en realidad un conjunto de plantillas para DocFlex/XML , un sistema de software para el desarrollo y ejecución de generadores de informes y documentación de alto rendimiento a partir de cualquier dato almacenado en archivos XML.

EJEMPLO

Aquí es una demostración de dicha documentación (fue generada por un único archivo fuente: http://developer.ebay.com/webservices/latest/ebaySvc.wsdl):

API de comercio de eBay - Documentación de WSDL

El HTML en sí: http://www.filigris.com/docflex-xml/wsdldoc/examples/html/ebaySvc/index.html

ENLACES

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/ajaxhispano.com/template/agent.layouts/content.php on line 61
2014-07-09 11:11:50

XMLSpy de Altova genera documentación HTML a partir de un WSDL ... pero no es gratis ;)

 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/ajaxhispano.com/template/agent.layouts/content.php on line 61
2009-04-15 21:45:54

Acabo de descubrir que Notepad++ con el plugin Xml Tools instalado también puede hacer transformaciones xsl. Si le proporciona el visor wsdl.xsl mencionado anteriormente y el archivo wsdl, obtendrá un html muy bien formateado como resultado.

 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/ajaxhispano.com/template/agent.layouts/content.php on line 61
2014-02-03 14:22:04

Sé que este es un método de documentación pobre, pero he utilizado abrir el XSD del wsdl en visual studio y hacer impresiones snag-it de eso con comentarios y flechas agregadas para mayor claridad y a nuestro cliente parece haberle gustado sin tener que usar otra herramienta. También puede que no tenga esto, pero podría usar una versión de una suscripción gratuita a VPC o MSDN También he utilizado el editor de esquemas BizTalk para ver el XSD y documentarlo desde allí usando snag-it u otra aplicación de captura de pantalla. Lo intentaría y usa lo que tienes!

-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/ajaxhispano.com/template/agent.layouts/content.php on line 61
2009-03-27 00:18:22

Puede usar "wsimport" que es parte del JDK y ejecutar Javadoc en los archivos generados. Suponiendo que haya puesto las anotaciones, las pondrá como parte de la documentación.

Otra herramienta sería Rational Application Developer que le permite hacer clic derecho y generar la documentación HTML con imágenes bastante hipervinculadas.

 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/ajaxhispano.com/template/agent.layouts/content.php on line 61
2010-08-04 16:11:17

Puedes usar iDocIt! para documentar un WSDL y exportar la documentación a HTML. Es un plugin de Eclipse de código abierto descargable aquí.

Proporciona un nuevo enfoque de creación de documentaciones con cuadrículas temáticas y roles temáticos, pero no es necesario usarlos. Puede crear documentaciones como texto sin formato.

 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/ajaxhispano.com/template/agent.layouts/content.php on line 61
2012-11-12 05:06:31