io.jmix.rest.impl.openapi

Interface OpenAPIGenerator

All Known Implementing Classes:

OpenAPIGeneratorImpl

public interface OpenAPIGenerator

This bean generates OpenAPI documentation according to the 3.1 specification.

Generated documentation includes operations with entities, predefined REST queries and exposed services.

Method Summary

Modifier and Type	Method and Description
io.swagger.v3.oas.models.OpenAPI	generateOpenAPI()

Method Detail

generateOpenAPI

io.swagger.v3.oas.models.OpenAPI generateOpenAPI()

Returns:

a OpenAPI object that can be transformed to JSON or YAML version of documentation