OpenApi or Swagger for REST Proxy API

AlesHolik · 23 February 2023 20:37

Please where can I find OpenApi or Swagger specification for REST Proxy API? Does it exist?

bbejeck · 27 February 2023 19:45

Hi

Yes we do - here’s the OpenApi spec for the REST Proxy API -

confluentinc/kafka-rest/blob/e288d17fb70d5eaae37f52b676c54e3929b36636/api/v3/openapi.yaml

openapi: 3.0.0

info:
  title: REST Admin API
  version: 3.0.0
  contact:
    name: Kafka REST Team
    url: https://confluent.slack.com/app_redirect?channel=kafka-rest-eng
    email: kafka-clients-proxy-team@confluent.io
  x-api-id: 499e3476-71e0-4d6f-b4f9-6776cec6df27
  x-api-group: v3
  x-audience: external-public
  x-tag-group: Cluster Admin for Kafka (%s)

servers:
  - url: "{protocol}://{address}:{port}/v3"
    x-audience: component-internal
    description: Kafka REST Proxy. See https://docs.confluent.io/current/kafka-rest/index.html.
    variables:
      address:

This file has been truncated. show original

And here are the docs for the cloud API - Confluent Cloud API Reference Documentation

AlesHolik · 28 February 2023 20:08

Thank you very much @bbejeck, this solved my problem!

Topic		Replies	Views
Confluent REST Proxy API Reference — Confluent Documentation 6.0.0 REST Proxy	0	3706	17 November 2020
The Confluent REST Proxy REST Proxy	0	4026	5 November 2020
Rest Proxy API Endpoint for Consuming Messages REST Proxy	12	5214	18 August 2022
How to use Rest API kafka With PHP Application? REST Proxy	1	3946	20 October 2021
How to make client library work with API Non-Java Clients	6	3809	20 April 2021

OpenApi or Swagger for REST Proxy API

Related topics