GET /
- return basic information about the Kafka Connect cluster such as the version of the Connect worker that serves the REST request (including git commit ID of the source code) and the Kafka cluster ID that is connected to.
+ For the complete specification of the REST API, see the OpenAPI documentation
+
Kafka Connect provides error reporting to handle errors encountered along various stages of processing. By default, any error encountered during conversion or within transformations will cause the connector to fail. Each connector configuration can also enable tolerating such errors by skipping them, optionally writing each error and the details of the failed operation and problematic record (with various levels of detail) to the Connect application log. These mechanisms also capture errors when a sink connector is processing the messages consumed from its Kafka topics, and all of the errors can be written to a configurable "dead letter queue" (DLQ) Kafka topic.
diff --git a/gradle/dependencies.gradle b/gradle/dependencies.gradle
index acad88aed53..935e5d8d205 100644
--- a/gradle/dependencies.gradle
+++ b/gradle/dependencies.gradle
@@ -117,6 +117,8 @@ versions += [
slf4j: "1.7.36",
snappy: "1.1.8.4",
spotbugs: "4.2.2",
+ swaggerAnnotations: "2.2.0",
+ swaggerJaxrs2: "2.2.0",
zinc: "1.3.5",
zookeeper: "3.6.3",
zstd: "1.5.2-1"
@@ -200,6 +202,8 @@ libs += [
slf4jApi: "org.slf4j:slf4j-api:$versions.slf4j",
slf4jlog4j: "org.slf4j:slf4j-log4j12:$versions.slf4j",
snappy: "org.xerial.snappy:snappy-java:$versions.snappy",
+ swaggerAnnotations: "io.swagger.core.v3:swagger-annotations:$versions.swaggerAnnotations",
+ swaggerJaxrs2: "io.swagger.core.v3:swagger-jaxrs2:$versions.swaggerJaxrs2",
zookeeper: "org.apache.zookeeper:zookeeper:$versions.zookeeper",
jfreechart: "jfreechart:jfreechart:$versions.jfreechart",
mavenArtifact: "org.apache.maven:maven-artifact:$versions.mavenArtifact",
diff --git a/gradle/openapi.template b/gradle/openapi.template
new file mode 100644
index 00000000000..d15c40c0070
--- /dev/null
+++ b/gradle/openapi.template
@@ -0,0 +1,24 @@
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License. You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+openapi: 3.0.0
+info:
+ version: $kafkaVersion
+ title: Kafka Connect REST API
+ description: "This is the documentation of the [Apache Kafka](https://kafka.apache.org) Connect REST API."
+ contact:
+ email: dev@kafka.apache.org
+ license:
+ name: Apache 2.0
+ url: https://www.apache.org/licenses/LICENSE-2.0.html