REST Settings

When you add a REST source to your project, TechWriter displays the following dialog.

Use the settings in this dialog to define a REST method that you wish to document.

REST Setting Description

URL Template A template of the URL used to call the REST method being defined where method parameters are designated using curly braces as placeholders.

HTTP Method The HTTP method used to call the REST method.

REST Setting	Description
URL Template	A template of the URL used to call the REST method being defined where method parameters are designated using curly braces as placeholders.
HTTP Method	The HTTP method used to call the REST method.

After specifying the URL template and HTTP method, TechWriter displays the following dialog.

In order for TechWriter to document the response from your REST method, it needs to call your REST method and analyze the response. If your REST method returns XML or JSON responses, TechWriter will use the response to infer the underlying data model. Use this dialog to specify a test request that can be used to call your method.

REST Setting Description

Request URL A URL used by TechWriter to call your REST method complete with necessary test parameter values for the method to execute successfully.

Request Content Test request file for HTTP POST or HTTP PUT methods.

Request Content Type The MIME type of the request content.

REST Setting	Description
Request URL	A URL used by TechWriter to call your REST method complete with necessary test parameter values for the method to execute successfully.
Request Content	Test request file for HTTP POST or HTTP PUT methods.
Request Content Type	The MIME type of the request content.

Tip: Make sure that XML and JSON responses contain data for every possible item. Anything missing from the response will be missing from the inferred data model.

REST Sample Request Authentication

If your web service uses Basic authentication, you can use this dialog to specify credentials to use when TechWriter calls your web service with the sample request.

REST Setting Description

Username User name to use to authenticate.

Password Password to use to authenticate.

REST Setting	Description
Username	User name to use to authenticate.
Password	Password to use to authenticate.