go-apiops

README

go-apiops

Home of Kong's Go based APIOps library.

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 for more information on APIOps concepts.

What is this library?

The go-apiops library provides a set of tools (generation and transformation) for working with API specifications and Kong Gateway 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. The library functionality will be be made available through the deck cli tool.

Installation & Usage

Currently, the functionality is released as a library and as part of the decK CLI tool. The repository also contains a CLI named go-apiops for local testing. For general CLI usage, the decK tool should be used.

Local Build

• make sure Go-lang tools 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.

Releasing new versions

The releases are automated. To create a new release:

• tag at the desired place to release

  git tag vX.Y.Z
  

• push the tag and CI will create a new release

  git push vX.Y.Z
  

• verify the release on the releases page, possibly edit the release-notes (which will be generated from the commit history)

Documentation

Overview

Copyright © 2023 NAME HERE <EMAIL ADDRESS>