Home

Goal: develop a tool to automatically generate a documentation of REST and SOAP remote APIs with sense for compatibility with Swagger and integration to the existing JBoss projects.

Objectives:

• Documentation will provide the same user experience for any of the remote interfaces.
• The tool focuses mainly on the output, documentation. (model is not standardized at the moment)
• The documented code has to be easily maintainable with no duplication.
• To generate documentation first time, user should do minimal steps to set it up. (no required annotations)

Features:

• Automatic analysis of REST and SOAP web services.
• Documentation annotations are optional.
• All configuration in the Maven plugin (only few parameters are required).
• Standards JAX-RS 2.0 and JAX-WS 2.0.
• Custom analysis and modification of API model.
• Ability to document generic types, Map<K,V> results, etc.
• Package filtering to include/exclude services.
• WebServiceProvider support in SOAP web services