An open API service indexing awesome lists of open source software.

https://github.com/kleister/kleister-go

Kleister: SDK for Golang
https://github.com/kleister/kleister-go

go golang kleister minecraft openapi sdk swagger

Last synced: 2 months ago
JSON representation

Kleister: SDK for Golang

Awesome Lists containing this project

README

          

# Kleister: SDK for Go

[![General Workflow](https://github.com/kleister/kleister-go/actions/workflows/general.yml/badge.svg)](https://github.com/kleister/kleister-go/actions/workflows/general.yml) [![Join the Matrix chat at https://matrix.to/#/#kleister:matrix.org](https://img.shields.io/badge/matrix-%23kleister%3Amatrix.org-7bc9a4.svg)](https://matrix.to/#/#kleister:matrix.org) [![Codacy Badge](https://app.codacy.com/project/badge/Grade/04c1aaaefa0442b08da36ce9f24193eb)](https://app.codacy.com/gh/kleister/kleister-go/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade) [![Go Reference](https://pkg.go.dev/badge/github.com/kleister/kleister-go.svg)](https://pkg.go.dev/github.com/kleister/kleister-go)

This repository provides a client SDK for Go. This SDK is automatically
generated by the [OAPI Codegen][oapicodegen] project.

## Build

If you are not familiar with [Nix][nix] it is up to you to have a working
environment for Go (>= 1.24.0) as the setup won't we covered within this guide.
Please follow the official install instructions for [Go][golang]. Beside that
we are using [go-task][gotask] to define all commands to build this project.

```console
git clone https://github.com/kleister/kleister-go.git
cd kleister-go

task clean generate openapi build test
```

If you got [Nix][nix] and [Direnv][direnv] configured you can simply execute
the following commands to get al dependencies including [go-task][gotask] and
the required runtimes installed:

```console
cat << EOF > .envrc
use flake . --impure --extra-experimental-features nix-command
EOF

direnv allow
```

## Examples

For different kind of examples how to use this library please take a look at the
[examples/](./examples) folder.

## Security

If you find a security issue please contact
[kleister@webhippie.de](mailto:kleister@webhippie.de) first.

## Contributing

Fork -> Patch -> Push -> Pull Request

## Authors

- [Thomas Boerger](https://github.com/tboerger)

## License

Apache-2.0

## Copyright

```console
Copyright (c) 2018 Thomas Boerger
```

[oapicodegen]: https://github.com/deepmap/oapi-codegen
[nix]: https://nixos.org/
[golang]: http://golang.org/doc/install.html
[gotask]: https://taskfile.dev/installation/
[direnv]: https://direnv.net/