This Document! X sample has been created to illustrate documentation of a REST web service. The web service used for this sample is for a pet store, and includes methods to manage users and pets.
Most of the content in this sample is contained directly within the web service definition and is used directly by Document! X, except for Json Schemas which in this instance did not contain descriptions for most items. Individual items can easily have this default content overriden by authoring in the Document! X Content File.
The resource groupings are also read directly from the web service definition, but individual resources can be moved between resource groups, resource groups can be renamed, and additional resource groups can be created (using the context menu on the Project Explorer) if required.
Customizations are stored as additional data in the Document! X project and will not prevent Document! X from reading changed or additional items from the web service definition should it change in future.
Json Schemas have been read from the web service definition as well as the resouce groups, resources and operations. If Json Schemas are not present in the web service definition, they can be added manually using the context menu on the Project Explorer in Document! X.
The loginUser operation illustrates an operation with parameters and a fault response.
The getPetById (Get) operation illustrates an operation that returns a Json response.