Class OpenAPIContract

java.lang.Object
io.vertx.reactivex.openapi.contract.OpenAPIContract
All Implemented Interfaces:
io.vertx.lang.rx.RxDelegate
public class OpenAPIContract extends Object implements io.vertx.lang.rx.RxDelegate

  • Field Details

    • __TYPE_ARG

      public static final io.vertx.lang.rx.TypeArg<OpenAPIContract> __TYPE_ARG

  • Constructor Details

    • OpenAPIContract

      public OpenAPIContract(OpenAPIContract delegate)

    • OpenAPIContract

      public OpenAPIContract(Object delegate)

  • Method Details

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • getDelegate

      public OpenAPIContract getDelegate()
      Specified by:
      getDelegate in interface io.vertx.lang.rx.RxDelegate

    • from

      public static Future<OpenAPIContract> from(Vertx vertx, String contractPath)
      Resolves / dereferences the passed contract and creates an OpenAPIContract instance.
      Parameters:
      vertx - The related Vert.x instance.
      contractPath - The path to the contract.
      Returns:
      A succeeded holding an OpenAPIContract instance, otherwise a failed .

    • rxFrom

      public static Single<OpenAPIContract> rxFrom(Vertx vertx, String contractPath)
      Resolves / dereferences the passed contract and creates an OpenAPIContract instance.
      Parameters:
      vertx - The related Vert.x instance.
      contractPath - The path to the contract.
      Returns:
      A succeeded holding an OpenAPIContract instance, otherwise a failed .

    • from

      public static Future<OpenAPIContract> from(Vertx vertx, JsonObject contract)
      Resolves / dereferences the passed contract and creates an OpenAPIContract instance.
      Parameters:
      vertx - The related Vert.x instance.
      contract - The contract.
      Returns:
      A succeeded holding an OpenAPIContract instance, otherwise a failed .

    • rxFrom

      public static Single<OpenAPIContract> rxFrom(Vertx vertx, JsonObject contract)
      Resolves / dereferences the passed contract and creates an OpenAPIContract instance.
      Parameters:
      vertx - The related Vert.x instance.
      contract - The contract.
      Returns:
      A succeeded holding an OpenAPIContract instance, otherwise a failed .

    • from

      public static Future<OpenAPIContract> from(Vertx vertx, String contractPath, Map<String,String> additionalContractPartPaths)
      Resolves / dereferences the passed contract and creates an OpenAPIContract instance.

      This method can be used in case that the contract is split into several parts. These parts can be passed in a Map that has the reference as key and the path to the part as value.

      Parameters:
      vertx - The related Vert.x instance.
      contractPath - The path to the contract.
      additionalContractPartPaths - The additional contract part paths
      Returns:
      A succeeded holding an OpenAPIContract instance, otherwise a failed .

    • rxFrom

      public static Single<OpenAPIContract> rxFrom(Vertx vertx, String contractPath, Map<String,String> additionalContractPartPaths)
      Resolves / dereferences the passed contract and creates an OpenAPIContract instance.

      This method can be used in case that the contract is split into several parts. These parts can be passed in a Map that has the reference as key and the path to the part as value.

      Parameters:
      vertx - The related Vert.x instance.
      contractPath - The path to the contract.
      additionalContractPartPaths - The additional contract part paths
      Returns:
      A succeeded holding an OpenAPIContract instance, otherwise a failed .

    • from

      public static Future<OpenAPIContract> from(Vertx vertx, JsonObject contract, Map<String, JsonObject> additionalContractParts)
      Resolves / dereferences the passed contract and creates an OpenAPIContract instance.

      This method can be used in case that the contract is split into several parts. These parts can be passed in a Map that has the reference as key and the part as value.

      Parameters:
      vertx - The related Vert.x instance.
      contract - The unresolved contract.
      additionalContractParts - The additional contract parts
      Returns:
      A succeeded holding an OpenAPIContract instance, otherwise a failed .

    • rxFrom

      public static Single<OpenAPIContract> rxFrom(Vertx vertx, JsonObject contract, Map<String, JsonObject> additionalContractParts)
      Resolves / dereferences the passed contract and creates an OpenAPIContract instance.

      This method can be used in case that the contract is split into several parts. These parts can be passed in a Map that has the reference as key and the part as value.

      Parameters:
      vertx - The related Vert.x instance.
      contract - The unresolved contract.
      additionalContractParts - The additional contract parts
      Returns:
      A succeeded holding an OpenAPIContract instance, otherwise a failed .

    • operation

      public Operation operation(String operationId)
      Access to an operation defined in the contract with operationId.
      Parameters:
      operationId - the id of the operation.
      Returns:
      the requested operation.

    • operations

      public List<Operation> operations()
      Returns:
      all operations defined in the contract.

    • getPaths

      public List<Path> getPaths()
      Returns:
      all Paths defined in the OpenAPI contract.

    • getRawContract

      public JsonObject getRawContract()
      Returns:
      the resolved OpenAPI contract as .

    • getVersion

      public OpenAPIVersion getVersion()
      Returns:
      the OpenAPI version of the contract.

    • getSchemaRepository

      public SchemaRepository getSchemaRepository()
      Returns:
      the to validate against.

    • getServers

      public List<Server> getServers()
      Returns:
      the servers of the contract.

    • findPath

      public Path findPath(String urlPath)
      Finds the related Path object based on the passed url path.
      Parameters:
      urlPath - The path of the request.
      Returns:
      the found Path object, or null if the passed path doesn't match any Path object.

    • findOperation

      public Operation findOperation(String urlPath, HttpMethod method)
      Finds the related Operation object based on the passed url path and method.
      Parameters:
      urlPath - The path of the request.
      method - The method of the request.
      Returns:
      the found Operation object, or null if the passed path and method doesn't match any Operation object.

    • getSecurityRequirements

      public List<SecurityRequirement> getSecurityRequirements()
      Returns the applicable list of global security requirements (scopes) or empty list.
      Returns:
      The related security requirement.

    • securityScheme

      public SecurityScheme securityScheme(String name)
      Gets the related SecurityScheme object based on the passed name.
      Parameters:
      name - The name of the security scheme.
      Returns:
      the found SecurityScheme object, or null if the passed path and method doesn't match any Operation object.

    • builder

      public static OpenAPIContractBuilder builder(Vertx vertx)
      Instantiates a new builder for an openapi-contract.
      Parameters:
      vertx - The vert.x instance
      Returns:
      A new builder.

    • newInstance

      public static OpenAPIContract newInstance(OpenAPIContract arg)