2009-03-26 14 views
46

Cách tiếp cận của bạn để tạo ra một số loại tài liệu có thể đọc được từ con người từ WSDL là gì? Trong quá khứ tôi đã sử dụng WSDL viewer (bởi Tomi Vanek) (xem my blog post about integrating it into NAnt) và tôi hài lòng với kết quả, nhưng tôi quan tâm đến bất kỳ lựa chọn thay thế có thể.Tạo tài liệu HTML từ WSDL

Tôi cũng đã nghe nói về x3sp, nhưng tôi chưa thử.

Trả lời

17

Tôi đã thử nhiều lựa chọn thay thế

  • TechWriter for Web Services: Thật mạnh mẽ, nhưng đầu ra HTML là (xem nhận xét) nhiều tập tin. Ngoài ra, các nhận xét cho biết nó đã được gỡ bỏ, nhưng đó không còn là trường hợp.
  • <oXygen/> XML Editor: Nó không xử lý lược đồ được nhúng.
  • Altova XML Spy: Nó không xử lý các loại ẩn danh.

và kết thúc điều chỉnh trình xem WSDL theo nhu cầu của tôi.

+3

Phiên bản hiện tại của TechWriter cho Dịch vụ Web cũng hỗ trợ đầu ra HTML trang đơn. –

+0

Điều tương tự ở đây. tôi đã đi xem wsdl. soapui pro sử dụng nó quá haha ​​ –

+1

TechWriter đã được gỡ bỏ ... một số có thể chia sẻ một số giấy phép? – willyMon

1

Tôi biết đây là phương pháp tài liệu của người nghèo, nhưng tôi đã sử dụng XSD của wsdl trong studio trực quan và thực hiện các bản in có chú thích và mũi tên được thêm vào để rõ ràng và khách hàng của chúng tôi có vẻ thích nó để sử dụng công cụ khác. Bạn cũng có thể không có điều này nhưng có thể sử dụng một phiên bản từ một thuê bao VPC hoặc MSDN miễn phí, tôi cũng đã sử dụng trình soạn thảo lược đồ BizTalk để xem XSD và ghi tài liệu từ đó bằng cách sử dụng snag-it hoặc một ứng dụng chụp màn hình khác. Tôi sẽ thử và sử dụng những gì bạn có!

-Bryan

2

XMLSpy Altova của không tạo ra tài liệu HTML từ một WSDL ... nhưng nó không phải là miễn phí;)

0

Bạn có thể sử dụng "wsimport" là một phần của JDK và chạy Javadoc trên các tệp được tạo. Giả sử bạn đã đưa vào các chú thích, nó sẽ đặt chúng như một phần của tài liệu.

Công cụ khác sẽ là Rational Application Developer cho phép bạn nhấp chuột phải và tạo tài liệu HTML có hình ảnh siêu liên kết đẹp.

8

Sử dụng http://code.google.com/p/wsdl-viewer/ và xsltproc Cygwin của

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

trình như một say mê

+1

nó trông giống như sản phẩm khác nhau lúc đầu, nhưng tôi có thể nhìn thấy nó giống như bây giờ :)) –

+0

làm việc tuyệt vời nhưng không đi quá sâu vào XSD nếu một trong những đi kèm với các tập tin bên ngoài. tôi đã phải sử dụng trình xem + lược đồ này cũng như –

8

Vâng, đó là một hình mới: wsdl2html. Nó tập trung vào yêu cầu/phản hồi và loại bỏ thông tin mà mọi người không quan tâm.

+2

Liên kết này đã chết. – Vaccano

+0

Tôi đã thử sử dụng nhưng tôi không nhận được danh sách đầy đủ các dịch vụ. Chỉ một trong 27 dịch vụ của tôi đã được hiển thị – Lai

+0

Tôi thích sự đơn giản của wsdl2html, điều này giúp việc truyền đạt thông tin cần thiết về một dịch vụ mà không gây nhầm lẫn cho khán giả. Theo tôi, tính năng quan trọng duy nhất còn thiếu là nhận được mô tả/bình luận cho các hoạt động và các yếu tố. – Juanal

0

Bạn có thể sử dụng iDocIt! để ghi lại một WSDL và xuất ra tài liệu đó thành HTML. Nó là một plugin Eclipse nguồn mở có thể tải về here.

Nó cung cấp một cách tiếp cận mới để tạo tài liệu với lưới chuyên đề và vai trò chuyên đề, nhưng bạn không cần sử dụng chúng. Bạn có thể tạo tài liệu tĩnh dưới dạng văn bản thuần túy.

2

Tôi vừa phát hiện ra rằng Notepad ++ với plugin Công cụ Xml được cài đặt cũng có thể thực hiện các phép biến đổi xsl. Nếu bạn cung cấp cho nó tệp wsdl-viewer.xsl được đề cập trước đó và tệp wsdl, bạn sẽ nhận được một định dạng html độc đáo.

+0

Nếu bạn sử dụng Eclipse với các tính năng EE, nó cho phép bạn xử lý tệp XSLT bằng cách nhấp chuột phải vào tệp đó và chọn Chạy. – Juanal

5

Bây giờ, có thêm một công cụ cho việc này, được gọi là "DocFlex/XML WSDLDoc".

Đây là trình tạo tài liệu WSDL/XSD mới cho phép bạn ghi lại bất kỳ số lượng tệp WSDL và XML schema (XSD) nào cùng với bất kỳ kết nối nào giữa chúng.

Ngoài ra còn có một tùy chọn để tự động đưa vào sơ đồ XSD được tạo bởi Altova XMLSpy hoặc Oxygen XML. Hiệu quả, bất kỳ trong số chúng có thể được sử dụng như động cơ sơ đồ liên kết động.

KEY FEATURES

  • Thế hệ của đơn đóng khung (Javadoc-like) tài liệu HTML bởi bất kỳ số lượng WSDL/file XSD với nhau. (Nếu bạn có quá nhiều tệp đầu vào, bạn có thể chọn tất cả chúng bằng cách sử dụng mẫu tên đường dẫn giống Ant).
  • Xử lý bất kỳ số lượng lược đồ XML (cùng với WSDL) bao gồm:
    • Trong dạng tập tin XSD riêng
    • lược đồ XML nhúng trong WSDL (trong vòng <wsdl:definitons>/<wsdl:types> yếu tố)
  • Đang xử lý bất kỳ nào được tham chiếu tệp WSDL và lược đồ XML, cụ thể:
    • Xử lý chính xác tất cả các phần tử <wsdl:import>, <xs:import>, <xs:include>, <xs:redefine> được tìm thấy trên tất cả các tệp WSDL/XSD có liên quan.
    • Tải và xử lý tự động (tức là bao gồm phạm vi tài liệu) tất cả các tệp WSDL/XSD được tham chiếu trực tiếp/gián tiếp.
  • chủ tài liệu tinh vi của thành phần XSD (tài liệu XML schema):
    • Hỗ trợ của bất kỳ mẫu thiết kế lược đồ XML.
    • Khả năng tự động bao gồm sơ đồ XSD được tạo bởi XMLSpy hoặc Oxygen XML, với sự hỗ trợ của tất cả các siêu liên kết biểu đồ.
  • tư liệu của tất cả các mối liên kết giữa các định nghĩa WSDL và các thành phần XSD:
    • Hyperlinks từ WSDL thông điệp đến các chi tiết của các yếu tố XSD/loại mô tả các thông điệp dữ liệu.
    • Trong chi tiết phần tử/loại XSD, danh sách tất cả các định nghĩa WSDL mà chúng được sử dụng.
    • Sao chép chú thích của các phần tử/loại XSD vào tài liệu của các thông điệp WSDL đó (và thậm chí cả các hoạt động) nơi chúng được sử dụng.
  • Khả năng không giới hạn tùy chỉnh.WSDLDoc thực sự là một mẫu được thiết lập cho DocFlex/XML, một hệ thống phần mềm để phát triển và thực thi các tài liệu hiệu suất cao và các trình tạo báo cáo từ bất kỳ dữ liệu nào được lưu trữ trong các tệp XML.

VÍ DỤ

Đây là một bản demo của tài liệu đó (nó được tạo ra bởi một tập tin nguồn duy nhất: http://developer.ebay.com/webservices/latest/ebaySvc.wsdl):

eBay Trading API - WSDL documentation

HTML riêng của mình: http://www.filigris.com/docflex-xml/wsdldoc/examples/html/ebaySvc/index.html

LIÊN KẾT

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

+0

Tôi đã sử dụng sản phẩm XML doc trong một thời gian và tôi hoàn toàn hài lòng về chất lượng sản phẩm .... quá tệ đến mức công ty của tôi không có ngân sách để mua một số giấy phép, nhưng tôi rất vui khi mua một sản phẩm cho bản thân mình ... – PierluigiVernetto

+0

Có vẻ như sản phẩm thương mại, yêu cầu giấy phép cho đầy đủ chức năng –

4

Nó không được liệt kê ở đây, nhưng SoapUI có một máy phát tài liệu wsdl hữu ích.

Nhấp chuột phải vào dự án của bạn và chọn "Tạo tài liệu".

+0

Dường như sử dụng wsdl-viewer.xsl đã đề cập trước đó (đã chuyển sang Apache Woden), đầu ra trông giống nhau. – Clauds

+0

Đã làm việc tuyệt vời. Đã có một dự án được tạo ra trong SOAPUI, và nó tạo ra một trang html đẹp cho tôi. – MattC