com.vaadin.flow.server.connect.generator.OpenApiObjectGenerator API 20.0.8 | Vaadin

You're viewing an older version of Vaadin JavaDoc. Please see version 24.7.0 for the latest.

com.vaadin.flow.server.connect.generator.

java.lang.Object
- com.vaadin.flow.server.connect.generator.OpenApiObjectGenerator

```
public class OpenApiObjectGenerator
extends Object
```
Java parser class which scans for all Endpoint classes and produces OpenApi json.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`CONSTRAINT_ANNOTATIONS`
`static String`	`EXTENSION_VAADIN_CONNECT_PARAMETERS_DESCRIPTION`
`static String`	`EXTENSION_VAADIN_FILE_PATH`

Constructor Summary

Constructors
Constructor and Description

OpenApiObjectGenerator()

Method Summary

All Methods
Modifier and Type	Method and Description
`void`	`addSourcePath(Path sourcePath)` Adds the source path to the generator to process.
`io.swagger.v3.oas.models.OpenAPI`	`getOpenApi()` Gets the Open API, generates it if necessary.
`void`	`setOpenApiConfiguration(OpenApiConfiguration configuration)` Sets the configuration to be used when generating an Open API spec.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - EXTENSION_VAADIN_CONNECT_PARAMETERS_DESCRIPTION
```
public static final String EXTENSION_VAADIN_CONNECT_PARAMETERS_DESCRIPTION
```
    See Also:
    
    Constant Field Values
  - EXTENSION_VAADIN_FILE_PATH
```
public static final String EXTENSION_VAADIN_FILE_PATH
```
    See Also:
    
    Constant Field Values
  - CONSTRAINT_ANNOTATIONS
```
public static final String CONSTRAINT_ANNOTATIONS
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - OpenApiObjectGenerator
```
public OpenApiObjectGenerator()
```
- Method Detail
  - addSourcePath
```
public void addSourcePath(Path sourcePath)
```
    Adds the source path to the generator to process.
    
    Parameters:
    
    sourcePath - the source path to generate the medatata from
  - setOpenApiConfiguration
```
public void setOpenApiConfiguration(OpenApiConfiguration configuration)
```
    Sets the configuration to be used when generating an Open API spec.
    
    Parameters:
    
    configuration - the generator configuration
  - getOpenApi
```
public io.swagger.v3.oas.models.OpenAPI getOpenApi()
```
    Gets the Open API, generates it if necessary.
    
    Returns:
    
    the Open API data