Document! X supports documentation of Web Services (SOAP and REST). Web Service documentation produces 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 Page) 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.
SOAP Web Services
To document SOAP Web Services, Document! X can directly read from a WSDL document (see the Fundamentals section below for a step by step guide to adding a new Web Service, selecting WSDL File as the Web Service Definition Source).
Most Web Services will publish a WSDL document automatically, typically available by calling the root service uri with a ?WSDL suffix, e.g. http://api.microsofttranslator.com/V2/Soap.svc?WSDL
REST Web Services
REST Web Services do not enjoy a single commonly implemented definition standard, but Document! X can automatically determine the structure of your web service using several different sources, which your web service may or may not already publish:
WADL (Web Application Definition Language) Document: This REST version of the popular WSDL standard has not seen wide adoption, but if your web service architecture is able to generate a WADL document, Document! X can use it. See the Fundamentals section below for a step by step guide to adding a new Web Service, selecting WADL File as the Web Service Definition Source.
Swagger: An open standard specifically designed for documenting REST Apis. See the Fundamentals section below for a step by step guide to adding a new Web Service, selecting Swagger API Definition as the Web Service Definition Source.
WCF REST Help Page: If your REST service is implemented using WCF REST, a help page is automatically available that Document! X can use to determine the structure of your Web Service. The help page is available by calling the root service uri with a /Help suffix, e.g. . See http://msdn.microsoft.com/en-GB/library/ee230442.aspx for more information on the WCF REST Help Page. See the Fundamentals section below for a step by step guide to adding a new Web Service, selecting WCF REST Help Page as the Web Service Definition Source.
ASP.NET Web Api Help Page: If your REST service is implemented using ASP.NET Web Api, Document! X can use the help pages feature to determine the structure of your Web Service, and to discover Xml comments you have included in your service source code. For ASP.NET Web Api 2, the help pages functionality is automatically included in the new project template. For earlier versions of Web Api you can add this feature to your Web Api project in Visual Studio as a nuget package - see http://www.asp.net/web-api/overview/creating-web-apis/creating-api-help-pages for more information.
If your web service does not publish structural information that Document! X can automatically read, you can still document your web service by defining the structure manually. See the Fundamentals section below for a step by step guide to adding a new Web Service, unticking the Read Web Service Definition from an existing source option. You can then use commands on the context menu in the project explorer to add the Resource Groups, Resources, Operations, Requests, Responses and Parameters that make up your web service.
If you are documenting your Web Service from a Web Service Definition, Document! X will use any available descriptive content contained within the Web Service definition automatically. For example, the WSDL standard supports documentation elements which Document! X will use as the default summary for the related item.
The level of support for defining descriptive content in the Web Service Definition will depend on the technology you use to develop your web service. Refer to the documentation for the development tools you use to create your Web Service for more information.
Create a new Web Service Documentation Project
The new empty documentation project will be created and opened for edit. You can now add the Web Service(s) that you wish to document:
The Web Service be added to the Project Explorer under the Web Services node. You can expand down through the Web Service node to tick / untick individual elements in order to include / exclude them from the generated output. Repeat the process above to add additional Web Services to this project.
A Content File will be created and added to the project under the Content Files node for each added Web Service. You can use this Content File to author additional content in the pages that Document! X will automatically generate.
If your Web Service is a SOAP Web Service that includes embedded XSD Schemas, those XSD Schemas will also be added to the Project and a Content File created for each one so that you can document them together with the Web Service which uses them.
Author content for the Web Service
If you would like to supplement the content of the pages automatically generated by Document! X, you can do so using the Document! X Content File Editor.
The Content File Editor allows you to review and author content for any item for which a reference documentation page is generated.
To open the Content File Editor:
Add Conceptual Topics
Conceptual information is a key part of reference documentation, providing a high level introduction, tutorials or other conceptual information. You can easily create conceptual topics in Document! X.
You can find more information on Topic Editing in the Topic Editor topic.
Change Web Service documentation settings
The settings that govern Web Service Documentation generation are defined in the Build Profile editor. In a new project there is a single Build Profile but you can define many build profiles if you want to create multiple outputs with different settings.
To edit Web Service documentation settings:
In the Build Profile editor, you can find the Web Service Settings page under the Reference Documentation section.
You can change the Template used for Web Service documentation (which defines the look and feel of generated pages) on the Templates page.
Identify undocumented items
An essential part of delivering a complete documentation set is ensuring that all the items have been documented. Document! X includes the Undocumented Items tool to quickly and easily identify undocumented items.
To identify undocumented items:
See the Undocumented Items topic for more information.
Build and deploy Web Service reference documentation
Click the Build Ribbon button on the Project ribbon tab to build your Web Service reference documentation.
Refer to the Deployment topic for more information on how to deploy your documentation to other machines.