Document! X for Web Service Documentation
Automated Web Service Documentation Tool + WYSIWYG Authoring Environment
Document! X delivers the best of both worlds by seamlessly combining automatic documentation of Web Services (SOAP and REST) with a full WYSIWYG authoring environment. The generated Web Service documentation forms a comprehensive documentation set for your Web Services covering resource groups, operations, requests, responses and parameters.
Document! X can use a variety of definition sources (WSDL, WADL, Swagger, WCF REST Help Pages) to automatically determine the structure of your web service, or you can add an empty Web Service to the project and define the structure manually.
Content Authoring Options
If you have already defined descriptions in your source Web Service Definition (WSDL Annotations, Swagger Descriptions etc.), Document! X can use them as summary text for the generated documentation and you can view the web service definition descriptions whilst you are editing to spot areas that need expansion and avoid duplication.
You can choose to author content in your Web Service Definition (WSDL Annotations, Swagger Descriptions etc.), and/or using the rich authoring environment of the Document! X Content File editor. This flexibility allows you to include basic documentation in the source code and use the rich Document! X Content File editor to author extended content.
/@Html.Partial("_ScreenshotGallery", New ScreenshotSetPageViewModel("", Model.ScreenshotConfiguration.ScreenshotSets("").Screenshots, ""))/@Html.Partial("_ScreenshotGallery", New ScreenshotSetPageViewModel("webservice-authoring", Model.ScreenshotConfiguration.ScreenshotSets("webservice-authoring").Screenshots, ""))Embedded Schemas and Schema Diagrams
If your web service definition contains embedded XSD XML Schemas, Document! X will automatically document them. In addition to documenting the XML Schema objects themselves, Document! X will also generate relationship diagrams to illustrate the relationships between schema items (example below).
Single Source Build and Publish
Your documentation projects can be built to Browser Help, CHM (Html Help 1.x) or Microsoft Help Viewer (Visual Studio® 2010-2022). All of the specific requirements for the different output formats are handled for your automatically and you can build all outputs from a single project. Automatic publishing makes it quick and simple to deploy the generated output to your web site, ftp server or network location.
/@Html.Partial("_ScreenshotGallery", New ScreenshotSetPageViewModel("webservice-build-and-publish", Model.ScreenshotConfiguration.ScreenshotSets("webservice-build-and-publish").Screenshots, ""))