Package org.apache.tapestry5.services.rest

# Interface OpenApiDescriptionGenerator

All Known Implementing Classes:
  `DefaultOpenApiDescriptionGenerator`

@UsesOrderedConfiguration(OpenApiDescriptionGenerator.class) public interface OpenApiDescriptionGenerator
Service used to generate OpenAPI 3.0 description in JSON format for an application REST endpoints (i.e. REST endpoint event handler methods). A base implementation, DefaultOpenApiDescriptionGenerator, is automatically added as the first contribution to the service's distributed configuration. Other implementations of this interface can be contributed to further customize the description.

- ## Method Summary

  Modifier and Type
  Method
  Description
  `JSONObject`
  `generate(JSONObject documentation)`
  Generates or customizes the OpenAPI 3.0 documentation for this webapp's REST endpoints.

- ## Method Details

  - ### generate

    JSONObject generate(JSONObject documentation)
    Generates or customizes the OpenAPI 3.0 documentation for this webapp's REST endpoints.
    Parameters:
      `documentation` - a `JSONObject` object.
    Returns:
      the generated or customized OpenAPI 3.0 documentation as a JSON object.