https://github.com/api-zip/api-zip

The Zip API Object Framework
https://github.com/api-zip/api-zip

framework golang kubernetes

Last synced: 22 days ago
JSON representation

The Zip API Object Framework

• Host: GitHub
• URL: https://github.com/api-zip/api-zip
• Owner: api-zip
• License: bsd-3-clause
• Created: 2023-05-18T19:19:59.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2024-12-12T23:27:57.000Z (over 1 year ago)
• Last Synced: 2025-04-10T13:55:18.477Z (12 months ago)
• Topics: framework, golang, kubernetes
• Language: Go
• Homepage: https://api.zip
• Size: 28.3 KB
• Stars: 5
• Watchers: 1
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

          
# The Zip API Object Framework

[![](https://pkg.go.dev/badge/api.zip.svg)](https://pkg.go.dev/api.zip)

![](https://img.shields.io/static/v1?label=license&message=BSD-3&color=%23385177)

[![Go Report Card](https://goreportcard.com/badge/api.zip)](https://goreportcard.com/report/api.zip)

![Latest release](https://img.shields.io/github/v/release/api-zip/api-zip)

This project contains the low-level object framework Zip API.  It enables

Kubernetes-inspired objects without the hassle of code generation.

## Usage

To define your objects using the framework, simply import `api.zip` and declare

a `zip.Object` along with a Spec and Status to get started.

```go

import "api.zip"

type BookSpec struct {

	Name   string

	Author string

}

type BookState string

const (

	BookStateAvailable   = BookState("available")

	BookStateUnavailable = BookState("unavailable")

)

type BookStatus struct {

	State BookState

}

type (

	Book     = zip.Object[BookSpec, BookStatus]

	BookList = zip.ObjectList[BookSpec, BookStatus]

)

```

## License

The Zip API Object Framework is licensed under [BSD-3-Clause](/LICENSE.md).