Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

WADL documents can include doc fragments.

Users may want to use Description annotations which can be attached to resource classes and methods.

Note that starting from CXF 2.4.0, Description annotations can be applied to input parameters. Additionally, a method-level Descriptions annotation can have a collection of categorized Description annotations, with each Description targeting a specific WADL element by setting its 'target' property to one of the DocTarget values. For example, one can use a Descriptions annotation to document the response representation of a particular resource method, as well as add documentation fragments to WADL wadl:method/wadl:request and wadl:method/wadl:response elements:

...

  • applicationTitle: can be used to create an application title.
  • namespacePrefix: defaut is 'prefix', it can be set to other value such as 'ns'.
  • ignoreForwardSlash: can be used to enforce that resource path values do not start from '/'
  • addResourceAndMethodIds: WadlGenerator will add "id" attributes to wadl:resource and wadl:method elements

An ElementClass annotation can help with representing JAX-RS Response elements in the generated WADL.

...

If no JAXB is used then you can attach an XMLName annotation to method input or output types. Alternatively, you can register an instance of ElementQNameResolver with the WadlGenerator which will be used for creating wadl:representation/@element values.

...