Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Kong/go-apiops
Kong's Go based APIOps library
https://github.com/Kong/go-apiops
api apiops golang kong oas3 openapi
Last synced: 7 days ago
JSON representation
Kong's Go based APIOps library
- Host: GitHub
- URL: https://github.com/Kong/go-apiops
- Owner: Kong
- License: apache-2.0
- Created: 2023-01-05T14:11:53.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-10-29T09:40:51.000Z (17 days ago)
- Last Synced: 2024-10-29T11:41:36.249Z (17 days ago)
- Topics: api, apiops, golang, kong, oas3, openapi
- Language: Go
- Homepage:
- Size: 496 KB
- Stars: 20
- Watchers: 10
- Forks: 10
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Security: docs/security-o2k.md
Awesome Lists containing this project
- jimsghstars - Kong/go-apiops - Kong's Go based APIOps library (Go)
README
# go-apiops
Home of Kong's Go based APIOps library.
[](https://github.com/kong/go-apiops/actions?query=branch%3Amain+event%3Apush)
[](https://github.com/kong/go-apiops/actions?query=branch%3Amain+event%3Apush)
[](https://codecov.io/gh/Kong/go-apiops)
[](https://goreportcard.com/report/github.com/kong/go-apiops)
[](https://github.com/Kong/go-apiops/releases)
[](LICENSE)
## What is APIOps
API Lifecycle Automation, or APIOps, is the process of applying API best practices via automation frameworks.
This library contains functions to aid the development of tools to apply APIOps to Kong Gateway deployments.
See the [Kong Blog](https://konghq.com/blog/tag/apiops) for more information on APIOps concepts.
## What is this library?
The [go-apiops](https://github.com/Kong/go-apiops) library provides a set of tools (generation and transformation)
for working with API specifications and [Kong Gateway](https://docs.konghq.com/gateway/latest/) declarative configurations.
Conceptually, these tools are intended to be organized into a pipeline of individual steps configured for a particular
users needs. The overall purpose of the library is to enable users to build a CI/CD workflow which deliver APIs from
specification to deployment. This pipeline design allows users to customize the delivery of APIs based on their specific needs.
## What is the current status of this library?
The library is an [Apache 2.0 license](LICENSE).
The library functionality will be be made available through
the [deck](https://docs.konghq.com/deck/latest/) cli tool.
## Installation & Usage
Currently, the functionality is released as a library and as part of the [decK](https://github.com/Kong/deck) CLI tool. The repository also contains a CLI named `go-apiops` for local testing.
For general CLI usage, the [decK tool](https://docs.konghq.com/deck/latest/) should be used.
### Local Build
* make sure [Go-lang tools](https://go.dev/doc/install) are installed
* Checkout the Git repository (switch to a specific tag to select a version if required)
* use the makefile to build the project via `make build`
## Reporting issues
Issues using the `go-apiops` CLI or the library can be reported in the [Github repo](https://github.com/Kong/go-apiops/issues).
## Releasing new versions
The releases are automated. To create a new release:
* tag at the desired place to release
``` bash
git tag vX.Y.Z
```
* push the tag and CI will create a new release
```bash
git push vX.Y.Z
```
* verify the release on [the releases page](https://github.com/Kong/go-apiops/releases), possibly edit the release-notes (which will be generated from the commit history)