Package io.vertx.openapi.contract
Interface OpenAPIContract
-
public interface OpenAPIContract
-
-
Method Summary
All Methods Static Methods Instance Methods Abstract Methods Modifier and Type Method Description OperationfindOperation(String urlPath, HttpMethod method)Finds the relatedOperationobject based on the passed url path and method.PathfindPath(String urlPath)Finds the relatedPathobject based on the passed url path.static Future<OpenAPIContract>from(Vertx vertx, JsonObject unresolvedContract)Resolves / dereferences the passed contract and creates anOpenAPIContractinstance.static Future<OpenAPIContract>from(Vertx vertx, JsonObject unresolvedContract, Map<String,JsonObject> additionalContractFiles)Resolves / dereferences the passed contract and creates anOpenAPIContractinstance.static Future<OpenAPIContract>from(Vertx vertx, String unresolvedContractPath)Resolves / dereferences the passed contract and creates anOpenAPIContractinstance.static Future<OpenAPIContract>from(Vertx vertx, String unresolvedContractPath, Map<String,String> additionalContractFiles)Resolves / dereferences the passed contract and creates anOpenAPIContractinstance.List<Path>getPaths()JsonObjectgetRawContract()SchemaRepositorygetSchemaRepository()List<SecurityRequirement>getSecurityRequirements()Returns the applicable list of global security requirements (scopes) or empty list.List<Server>getServers()OpenAPIVersiongetVersion()Operationoperation(String operationId)Access to an operation defined in the contract withoperationId.List<Operation>operations()SecuritySchemesecurityScheme(String name)Gets the relatedSecuritySchemeobject based on the passed name.
-
-
-
Method Detail
-
from
static Future<OpenAPIContract> from(Vertx vertx, String unresolvedContractPath)
Resolves / dereferences the passed contract and creates anOpenAPIContractinstance.- Parameters:
vertx- The related Vert.x instance.unresolvedContractPath- The path to the unresolved contract.- Returns:
- A succeeded
Futureholding anOpenAPIContractinstance, otherwise a failedFuture.
-
from
static Future<OpenAPIContract> from(Vertx vertx, JsonObject unresolvedContract)
Resolves / dereferences the passed contract and creates anOpenAPIContractinstance.- Parameters:
vertx- The related Vert.x instance.unresolvedContract- The unresolved contract.- Returns:
- A succeeded
Futureholding anOpenAPIContractinstance, otherwise a failedFuture.
-
from
static Future<OpenAPIContract> from(Vertx vertx, String unresolvedContractPath, Map<String,String> additionalContractFiles)
Resolves / dereferences the passed contract and creates anOpenAPIContractinstance.This method can be used in case that the contract is split into several files. These files can be passed in a Map that has the reference as key and the path to the file as value.
- Parameters:
vertx- The related Vert.x instance.unresolvedContractPath- The path to the unresolved contract.additionalContractFiles- The additional contract files- Returns:
- A succeeded
Futureholding anOpenAPIContractinstance, otherwise a failedFuture.
-
from
static Future<OpenAPIContract> from(Vertx vertx, JsonObject unresolvedContract, Map<String,JsonObject> additionalContractFiles)
Resolves / dereferences the passed contract and creates anOpenAPIContractinstance.This method can be used in case that the contract is split into several files. These files can be passed in a Map that has the reference as key and the path to the file as value.
- Parameters:
vertx- The related Vert.x instance.unresolvedContract- The unresolved contract.additionalContractFiles- The additional contract files- Returns:
- A succeeded
Futureholding anOpenAPIContractinstance, otherwise a failedFuture.
-
operation
Operation operation(String operationId)
Access to an operation defined in the contract withoperationId.- Parameters:
operationId- the id of the operation.- Returns:
- the requested operation.
- Throws:
IllegalArgumentException- if the operation id doesn't exist in the contract.
-
getRawContract
JsonObject getRawContract()
- Returns:
- the resolved OpenAPI contract as
JsonObject.
-
getVersion
OpenAPIVersion getVersion()
- Returns:
- the OpenAPI version of the contract.
-
getSchemaRepository
SchemaRepository getSchemaRepository()
- Returns:
- the
SchemaRepositoryto validate against.
-
findOperation
Operation findOperation(String urlPath, HttpMethod method)
Finds the relatedOperationobject based on the passed url path and method.
-
getSecurityRequirements
List<SecurityRequirement> getSecurityRequirements()
Returns the applicable list of global security requirements (scopes) or empty list.- Returns:
- The related security requirement.
-
securityScheme
SecurityScheme securityScheme(String name)
Gets the relatedSecuritySchemeobject based on the passed name.- Parameters:
name- The name of the security scheme.- Returns:
- the found
SecuritySchemeobject, or null if the passed path and method doesn't match anyOperationobject.
-
-