https://github.com/zq2599/strimzigo
https://github.com/zq2599/strimzigo
Last synced: 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/zq2599/strimzigo
- Owner: zq2599
- Created: 2022-12-04T12:11:45.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2022-12-04T12:26:36.000Z (over 3 years ago)
- Last Synced: 2025-02-24T05:12:38.277Z (over 1 year ago)
- Language: Shell
- Size: 76.2 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Go API client for openapi
The Strimzi Kafka Bridge provides a REST API for integrating HTTP based client applications with a Kafka cluster. You can use the API to create and manage consumers and send and receive records over HTTP rather than the native Kafka protocol.
## Overview
This API client was generated by the [OpenAPI Generator](https://openapi-generator.tech) project. By using the [OpenAPI-spec](https://www.openapis.org/) from a remote server, you can easily generate an API client.
- API version: 0.1.0
- Package version: 1.0.0
- Build package: org.openapitools.codegen.languages.GoClientCodegen
## Installation
Install the following dependencies:
```shell
go get github.com/stretchr/testify/assert
go get golang.org/x/oauth2
go get golang.org/x/net/context
```
Put the package under your project folder and add the following in import:
```golang
import openapi "github.com/zq2599/strimzigo"
```
To use a proxy, set the environment variable `HTTP_PROXY`:
```golang
os.Setenv("HTTP_PROXY", "http://proxy_name:proxy_port")
```
## Configuration of Server URL
Default configuration comes with `Servers` field that contains server objects as defined in the OpenAPI specification.
### Select Server Configuration
For using other server than the one defined on index 0 set context value `sw.ContextServerIndex` of type `int`.
```golang
ctx := context.WithValue(context.Background(), openapi.ContextServerIndex, 1)
```
### Templated Server URL
Templated server URL is formatted using default variables from configuration or from context value `sw.ContextServerVariables` of type `map[string]string`.
```golang
ctx := context.WithValue(context.Background(), openapi.ContextServerVariables, map[string]string{
"basePath": "v2",
})
```
Note, enum values are always validated and all unused variables are silently ignored.
### URLs Configuration per Operation
Each operation can use different server URL defined using `OperationServers` map in the `Configuration`.
An operation is uniquely identified by `"{classname}Service.{nickname}"` string.
Similar rules for overriding default operation server index and variables applies by using `sw.ContextOperationServerIndices` and `sw.ContextOperationServerVariables` context maps.
```golang
ctx := context.WithValue(context.Background(), openapi.ContextOperationServerIndices, map[string]int{
"{classname}Service.{nickname}": 2,
})
ctx = context.WithValue(context.Background(), openapi.ContextOperationServerVariables, map[string]map[string]string{
"{classname}Service.{nickname}": {
"port": "8443",
},
})
```
## Documentation for API Endpoints
All URIs are relative to *http://localhost*
Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*ConsumersApi* | [**Assign**](docs/ConsumersApi.md#assign) | **Post** /consumers/{groupid}/instances/{name}/assignments |
*ConsumersApi* | [**Commit**](docs/ConsumersApi.md#commit) | **Post** /consumers/{groupid}/instances/{name}/offsets |
*ConsumersApi* | [**CreateConsumer**](docs/ConsumersApi.md#createconsumer) | **Post** /consumers/{groupid} |
*ConsumersApi* | [**DeleteConsumer**](docs/ConsumersApi.md#deleteconsumer) | **Delete** /consumers/{groupid}/instances/{name} |
*ConsumersApi* | [**ListSubscriptions**](docs/ConsumersApi.md#listsubscriptions) | **Get** /consumers/{groupid}/instances/{name}/subscription |
*ConsumersApi* | [**Poll**](docs/ConsumersApi.md#poll) | **Get** /consumers/{groupid}/instances/{name}/records |
*ConsumersApi* | [**Seek**](docs/ConsumersApi.md#seek) | **Post** /consumers/{groupid}/instances/{name}/positions |
*ConsumersApi* | [**SeekToBeginning**](docs/ConsumersApi.md#seektobeginning) | **Post** /consumers/{groupid}/instances/{name}/positions/beginning |
*ConsumersApi* | [**SeekToEnd**](docs/ConsumersApi.md#seektoend) | **Post** /consumers/{groupid}/instances/{name}/positions/end |
*ConsumersApi* | [**Subscribe**](docs/ConsumersApi.md#subscribe) | **Post** /consumers/{groupid}/instances/{name}/subscription |
*ConsumersApi* | [**Unsubscribe**](docs/ConsumersApi.md#unsubscribe) | **Delete** /consumers/{groupid}/instances/{name}/subscription |
*DefaultApi* | [**Healthy**](docs/DefaultApi.md#healthy) | **Get** /healthy |
*DefaultApi* | [**Info**](docs/DefaultApi.md#info) | **Get** / |
*DefaultApi* | [**Openapi**](docs/DefaultApi.md#openapi) | **Get** /openapi |
*DefaultApi* | [**Ready**](docs/DefaultApi.md#ready) | **Get** /ready |
*ProducerApi* | [**Send**](docs/ProducerApi.md#send) | **Post** /topics/{topicname} |
*ProducerApi* | [**SendToPartition**](docs/ProducerApi.md#sendtopartition) | **Post** /topics/{topicname}/partitions/{partitionid} |
*SeekApi* | [**Seek**](docs/SeekApi.md#seek) | **Post** /consumers/{groupid}/instances/{name}/positions |
*SeekApi* | [**SeekToBeginning**](docs/SeekApi.md#seektobeginning) | **Post** /consumers/{groupid}/instances/{name}/positions/beginning |
*SeekApi* | [**SeekToEnd**](docs/SeekApi.md#seektoend) | **Post** /consumers/{groupid}/instances/{name}/positions/end |
*TopicsApi* | [**GetOffsets**](docs/TopicsApi.md#getoffsets) | **Get** /topics/{topicname}/partitions/{partitionid}/offsets |
*TopicsApi* | [**GetPartition**](docs/TopicsApi.md#getpartition) | **Get** /topics/{topicname}/partitions/{partitionid} |
*TopicsApi* | [**GetTopic**](docs/TopicsApi.md#gettopic) | **Get** /topics/{topicname} |
*TopicsApi* | [**ListPartitions**](docs/TopicsApi.md#listpartitions) | **Get** /topics/{topicname}/partitions |
*TopicsApi* | [**ListTopics**](docs/TopicsApi.md#listtopics) | **Get** /topics |
*TopicsApi* | [**Send**](docs/TopicsApi.md#send) | **Post** /topics/{topicname} |
*TopicsApi* | [**SendToPartition**](docs/TopicsApi.md#sendtopartition) | **Post** /topics/{topicname}/partitions/{partitionid} |
## Documentation For Models
- [BridgeInfo](docs/BridgeInfo.md)
- [Consumer](docs/Consumer.md)
- [ConsumerRecord](docs/ConsumerRecord.md)
- [CreatedConsumer](docs/CreatedConsumer.md)
- [Error](docs/Error.md)
- [KafkaHeader](docs/KafkaHeader.md)
- [OffsetCommitSeek](docs/OffsetCommitSeek.md)
- [OffsetCommitSeekList](docs/OffsetCommitSeekList.md)
- [OffsetRecordSent](docs/OffsetRecordSent.md)
- [OffsetRecordSentList](docs/OffsetRecordSentList.md)
- [OffsetsSummary](docs/OffsetsSummary.md)
- [Partition](docs/Partition.md)
- [PartitionMetadata](docs/PartitionMetadata.md)
- [Partitions](docs/Partitions.md)
- [ProducerRecord](docs/ProducerRecord.md)
- [ProducerRecordKey](docs/ProducerRecordKey.md)
- [ProducerRecordList](docs/ProducerRecordList.md)
- [ProducerRecordToPartition](docs/ProducerRecordToPartition.md)
- [ProducerRecordToPartitionList](docs/ProducerRecordToPartitionList.md)
- [ProducerRecordValue](docs/ProducerRecordValue.md)
- [Replica](docs/Replica.md)
- [SubscribedTopicList](docs/SubscribedTopicList.md)
- [TopicMetadata](docs/TopicMetadata.md)
- [Topics](docs/Topics.md)
## Documentation For Authorization
Endpoints do not require authorization.
## Documentation for Utility Methods
Due to the fact that model structure members are all pointers, this package contains
a number of utility functions to easily obtain pointers to values of basic types.
Each of these functions takes a value of the given basic type and returns a pointer to it:
* `PtrBool`
* `PtrInt`
* `PtrInt32`
* `PtrInt64`
* `PtrFloat`
* `PtrFloat32`
* `PtrFloat64`
* `PtrString`
* `PtrTime`
## Author