File: README.md

package info (click to toggle)
golang-github-kong-go-kong 0.15.0-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, bullseye, forky, sid, trixie
  • size: 620 kB
  • sloc: sh: 18; makefile: 4
file content (43 lines) | stat: -rw-r--r-- 1,329 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
# go-kong

Go bindings for Kong's Admin API

[![GoDoc](https://godoc.org/github.com/kong/go-kong?status.svg)](https://godoc.org/github.com/kong/go-kong/kong)
[![Build Status](https://github.com/kong/go-kong/workflows/CI%20Test/badge.svg)](https://github.com/kong/go-kong/actions?query=branch%3Amain+event%3Apush)
[![Go Report Card](https://goreportcard.com/badge/github.com/kong/go-kong)](https://goreportcard.com/report/github.com/kong/go-kong)

## Importing

```shell
go get github.com/kong/go-kong/kong
```

## Compatibility

`go-kong` is compatible with Kong 1.x and 2.x.
Semantic versioning is followed for versioning `go-kong`.

## Generators

Some code in this repo such as `kong/zz_generated.deepcopy.go` is generated
from API types (see `kong/types.go`).

After making a change to an API type you can run the generators with:

```shell
./hack/update-deepcopy-gen.sh
```

Note that the files generated will be placed in
`$GOPATH/src/github.com/kong/go-kong/` and if you were in another directory
when you ran the script you'll need to copy generated code from there, e.g.:

```shell
cp $(go env GOPATH)/src/github.com/kong/go-kong/kong/zz_generated.deepcopy.go \
    $(pwd)/kong/zz_generated.deepcopy.go
```

## License

go-kong is licensed with Apache License Version 2.0.
Please read the LICENSE file for more details.