com.haulmont.restapi.swagger

Interface SwaggerGenerator

All Known Implementing Classes:

SwaggerGeneratorBean

public interface SwaggerGenerator

This bean generates Swagger documentation according to the 2.0 specification.

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

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	NAME

Method Summary

Modifier and Type	Method and Description
io.swagger.models.Swagger	generateSwagger()

Field Detail

NAME

static final java.lang.String NAME

See Also:

Constant Field Values

Method Detail

generateSwagger

io.swagger.models.Swagger generateSwagger()

Returns:

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