rest openapi sink REST OpenAPI Sink

Provided by: "Apache Software Foundation"

Support Level for this Kamelet is: "Preview"

Load OpenAPI specification from URI and call an operation on the HTTP service. The request is generated respecting the rules given in the OpenAPI specification (e.g. path parameters, Content-Type).

Configuration Options

The following table summarizes the configuration options available for the rest-openapi-sink Kamelet:

Property Name Description Type Default Example

operation

Operation ID

Required The operation to call.

string

specification

Specification URI

Required URI to the OpenApi specification file.

string

https://api.example.com/openapi.json

Dependencies

At runtime, the rest-openapi-sink Kamelet relies upon the presence of the following dependencies:

  • camel:rest-openapi

  • camel:http

  • camel:kamelet

  • camel:core

Usage

This section describes how you can use the rest-openapi-sink.

Knative sink

You can use the rest-openapi-sink Kamelet as a Knative sink by binding it to a Knative object.

rest-openapi-sink-binding.yaml
apiVersion: camel.apache.org/v1alpha1
kind: KameletBinding
metadata:
  name: rest-openapi-sink-binding
spec:
  source:
    ref:
      kind: Channel
      apiVersion: messaging.knative.dev/v1
      name: mychannel
  sink:
    ref:
      kind: Kamelet
      apiVersion: camel.apache.org/v1alpha1
      name: rest-openapi-sink
    properties:
      operation: The Operation ID
      specification: https://api.example.com/openapi.json

Prerequisite

You have Camel K installed on the cluster.

Procedure for using the cluster CLI

  1. Save the rest-openapi-sink-binding.yaml file to your local drive, and then edit it as needed for your configuration.

  2. Run the sink by using the following command:

    kubectl apply -f rest-openapi-sink-binding.yaml

Procedure for using the Kamel CLI

Configure and run the sink by using the following command:

kamel bind rest-openapi-sink -p "sink.operation=The Operation ID" -p "sink.specification=\https://api.example.com/openapi.json" channel:mychannel

This command creates the KameletBinding in the current namespace on the cluster.

Kafka sink

You can use the rest-openapi-sink Kamelet as a Kafka sink by binding it to a Kafka topic.

rest-openapi-sink-binding.yaml
apiVersion: camel.apache.org/v1alpha1
kind: KameletBinding
metadata:
  name: rest-openapi-sink-binding
spec:
  source:
    ref:
      kind: KafkaTopic
      apiVersion: kafka.strimzi.io/v1beta1
      name: my-topic
  sink:
    ref:
      kind: Kamelet
      apiVersion: camel.apache.org/v1alpha1
      name: rest-openapi-sink
    properties:
      operation: The Operation ID
      specification: https://api.example.com/openapi.json

Prerequisites

  • You’ve installed Strimzi.

  • You’ve created a topic named my-topic in the current namespace.

  • You have Camel K installed on the cluster.

Procedure for using the cluster CLI

  1. Save the rest-openapi-sink-binding.yaml file to your local drive, and then edit it as needed for your configuration.

  2. Run the sink by using the following command:

    kubectl apply -f rest-openapi-sink-binding.yaml

Procedure for using the Kamel CLI

Configure and run the sink by using the following command:

kamel bind rest-openapi-sink -p "sink.operation=The Operation ID" -p "sink.specification=\https://api.example.com/openapi.json" kafka.strimzi.io/v1beta1:KafkaTopic:my-topic

This command creates the KameletBinding in the current namespace on the cluster.

Kamelet source file

https://github.com/apache/camel-kamelets/blob/main/kamelets/rest-openapi-sink.kamelet.yaml

Back to top