10 April 2007 - 1.7 |
The form editor attempts to dynamically build a user-friendly input form from the underlying XML-Schema definition for the current request message. The following screenshot shows the form created for one of the paypal api calls;
The toolbar contains buttons to Validate and Clear the current form. Clear will recreate an empty underlying request containg only required elements. Validating will show a clickable list of errors below the editor that can be used to move focus to the corresponding field that caused the error:
By default, the editor creates fields for all elements/attributes in the underlying schema for those structures that are available in the underlying message, which can both be usefull for inspection purposes but also annoying for testing purposes. Therefore, the toolbar contains a "View Type" combo which offers the following options:
For example the follwing shows the above request with the "Data" value selected
This setting will be rememebered between editing sessions.
The Form Editor supports most commons XML-Schema constructs but may have trouble displaying/editing/validating more complex schemas. Therefore, it is advisable to initially double-check the XML generated by the editor in one of the other editors. Since it is our ambition to fully support XML Schema, please let us know if you have schema constructs that are giving you (or the editor) trouble..
The following constructs should currently work fine:
A '*' after a field name denotes that it is required. All fields can show a small green question-mark which will show documentation information from the associated type in a tooltip.