Skip to main content

OpenAPI 3 support

Vert.x allows you to use your OpenApi 3 specification directly inside your code using the design first approach.

Vert.x-Web provides:

  • OpenAPI 3 compliant API specification validation with automatic loading of external Json schemas

  • Automatic request validation

  • Automatic mount of security validation handlers

  • Automatic 501 response for not implemented operations

  • Router factory to provide all these features to users

The router factory

You can create your web service based on OpenAPI3 specification with OpenAPI3RouterFactory. This class, as name says, is a router factory based on your OpenAPI 3 specification. OpenAPI3RouterFactory is intended to give you a really simple user interface to use OpenAPI 3 support. It includes:

  • Async loading of specification and its schema dependencies

  • Mount path with operationId or with combination of path and HTTP method

  • Automatic request parameters validation

  • Automatic convert OpenAPI style paths to Vert.x style paths

  • Lazy methods: operations (combination of paths and HTTP methods) are mounted in declaration order inside specification

  • Automatic mount of security validation handlers

Create a new router factory

To create a new router factory, you can use methods inside OpenAPI3RouterFactory:

For example:

require 'vertx-web-api-contract/open_api3_router_factory'
VertxWebApiContract::OpenAPI3RouterFactory.create_router_factory_from_file(vertx, "src/main/resources/petstore.yaml") { |ar_err,ar|
  if (ar_err == nil)
    # Spec loaded with success
    routerFactory = ar
  else
    # Something went wrong during router factory initialization
    exception = ar_err
  end
}

Mount the handlers

Now load your first path. There are two functions to load the handlers:

And, of course, two functions to load failure handlers

You can, of course, add multiple handlers to same operation, without overwrite the existing ones.

Important
Path in OpenAPI format
If you want to use addHandler or addFailureHandler pay attention: You can provide a path only in OpenAPI styles (for example path /hello/:param doesn’t work)

For example:

routerFactory.add_handler_by_operation_id("awesomeOperation") { |routingContext|
  params = routingContext.get("parsedParameters")
  body = params.body()
  jsonBody = body.get_json_object()
  # Do something with body
}
routerFactory.add_failure_handler_by_operation_id("awesomeOperation") { |routingContext|
  # Handle failure
}
Important
Add operations with operationId
Usage of combination of path and HTTP method is allowed, but it’s better to add operations handlers with operationId, for performance reasons and to avoid paths nomenclature errors

Now you can use parameter values as described in vertx-web documentation

Define security handlers

A security handler is defined by a combination of schema name and scope. You can mount only one security handler for a combination. For example:

routerFactory.add_security_handler("security_scheme_name", &securityHandler)

You can of course use included Vert.x security handlers, for example:

require 'vertx-web/jwt_auth_handler'
routerFactory.add_security_handler("jwt_auth", &VertxWeb::JWTAuthHandler.create(jwtAuthProvider).method(:handle))

Error handling

The router factory allows you to manage errors efficiently:

  • It automatically mounts a 501 Not Implemented handler for operations where you haven’t mounted any handler

  • It automatically mounts a 400 Bad Request handler that manages ValidationException (You can enable/disable this feature via enableValidationFailureHandler)

Generate the router

When you are ready, generate the router and use it:

router = routerFactory.get_router()

server = vertx.create_http_server({
  'port' => 8080,
  'host' => "localhost"
})
server.request_handler(&router.method(:accept)).listen()

Requests validation

Vert.x provides a validation framework that will validate requests for you and will put results of validation inside a container. To define a HTTPRequestValidationHandler:

require 'vertx-web-api-contract/http_request_validation_handler'
# Create Validation Handler with some stuff
validationHandler = VertxWebApiContract::HTTPRequestValidationHandler.create().add_query_param("parameterName", :INT, true).add_form_param_with_pattern("formParameterName", "a{4}", true).add_path_param("pathParam", :FLOAT)

Then you can mount your validation handler:

require 'vertx-web/body_handler'
# BodyHandler is required to manage body parameters like forms or json body
router.route().handler(&VertxWeb::BodyHandler.create().method(:handle))

router.get("/awesome/:pathParam").handler(&validationHandler.method(:handle)).handler() { |routingContext|
  # Get Request parameters container
  params = routingContext.get("parsedParameters")

  # Get parameters
  parameterName = params.query_parameter("parameterName").get_integer()
  formParameterName = params.form_parameter("formParameterName").get_string()
  pathParam = params.path_parameter("pathParam").get_float()
}.failure_handler() { |routingContext|
  failure = routingContext.failure()
  if (failure.class.name == 'Java::IoVertxExtWebApiValidation::ValidationException')
    # Something went wrong during validation!
    validationErrorMessage = failure.get_message()
  end
}

If validation succeeds, It returns request parameters inside RequestParameters, otherwise It will throw a ValidationException

Types of request parameters

Every parameter has a type validator, a class that describes the expected type of parameter. A type validator validates the value, casts it in required language type and then loads it inside a RequestParameter object. There are three ways to describe the type of your parameter:

Handling parameters

Now you can handle parameter values:

params = routingContext.get("parsedParameters")
awesomeParameter = params.query_parameter("awesomeParameter")
if (awesomeParameter != nil)
  if (!awesomeParameter.empty?())
    # Parameter exists and isn't empty
    # ParameterTypeValidator mapped the parameter in equivalent language object
    awesome = awesomeParameter.get_integer()
  else
    # Parameter exists, but it's empty
  end
else
  # Parameter doesn't exist (it's not required)
end

As you can see, every parameter is mapped in respective language objects. You can also get a json body:

body = params.body()
if (body != nil)
  jsonBody = body.get_json_object()
end