validar online example web-services documentation wsdl nant

web services - online - Generación de documentación HTML a partir de WSDL



wsdl online (10)

¡Puedes usar iDocIt! para documentar un WSDL y exportar luego la documentación a HTML. Es un plugin de Eclipse de código abierto que se puede descargar here .

Proporciona un nuevo enfoque de creación de documentación con grillas temáticas y roles temáticos, pero no necesita usarlos. Puede crear documentaciones aún como texto sin formato.

¿Cuáles son sus enfoques para generar algún tipo de documentación legible por humanos a partir de los WSDL? En el pasado, utilicé el visor WSDL (por Tomi Vanek) (consulte la publicación de mi blog sobre cómo integrarlo en NAnt ) y estoy contento con los resultados, pero estoy interesado en posibles alternativas.

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

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

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 cantidad de archivos de esquema WSDL y XML (XSD) más cualquier interconexión entre ellos.

También hay una opción para la inclusión automática de diagramas XSD generados por Altova XMLSpy u Oxygen XML. Efectivamente, cualquiera de ellos se puede usar como un motor de diagramación vinculado dinámicamente.

CARACTERÍSTICAS PRINCIPALES

  • Generación de documentación HTML en un solo marco (similar al Javadoc) por cualquier cantidad de archivos WSDL / XSD juntos. (Si tiene demasiados archivos de entrada, puede elegirlos todos usando un patrón de ruta de acceso parecido a Ant).
  • Procesamiento de cualquier cantidad de esquemas XML (junto con WSDL), incluidos:
    • En forma de archivos XSD separados
    • Esquemas XML incrustados en WSDL (dentro del elemento <wsdl:definitons>/<wsdl:types> )
  • Procesamiento de cualquier archivo WSDL referenciado y esquemas XML, en particular:
    • Procesamiento correcto de todos los elementos <wsdl:import> , <xs:import> , <xs:include> , <xs:redefine> que se encuentran en todos los archivos WSDL / XSD implicados.
    • Carga y procesamiento automáticos (es decir, inclusión en el alcance de la documentación) todos los archivos WSDL / XSD referenciados directa o indirectamente.
  • Documentación sofisticada de componentes XSD (documentación de esquema XML):
    • Soporte de cualquier patrón de diseño de esquema XML.
    • Posibilidad de inclusión automática de diagramas XSD generados por XMLSpy u 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 elementos / tipos XSD que describen los datos del mensaje.
    • En detalles de elemento / tipo de XSD, la lista de todas las definiciones de WSDL donde se usan.
    • Copie las anotaciones de elementos / tipos XSD en la documentación de esos mensajes WSDL (e incluso operaciones) donde se usan.
  • Posibilidad de personalización ilimitada. WSDLDoc es en realidad un conjunto de plantillas para DocFlex/XML , un sistema de software para el desarrollo y la ejecución de documentación de alto rendimiento y generadores de informes a partir de cualquier información almacenada en archivos XML.

EJEMPLO

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

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

CAMPO DE GOLF

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

Conozco el método de documentación de este pobre hombre, pero he utilizado la apertura del XSD del wsdl en el estudio visual y haciendo copias de eso con comentarios y flechas para mayor claridad y parece que a nuestro cliente le ha 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 VPC o MSDN gratuita. También he usado el editor de esquemas BizTalk para ver también el XSD y documentarlo desde allí usando snag-it u otra aplicación de captura de pantalla. ¡Trataría de usar lo que tienes!

-Bryan

Intenté varias alternativas

y terminé ajustando el visor WSDL a mis necesidades.

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

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

Puede usar "wsimport" que es parte del JDK y ejecutar Javadoc en los archivos generados. Presumiendo que ha puesto las anotaciones, las incluirá 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 muy hipervinculadas.

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

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