animals

module
v0.0.0-...-094a066 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Mar 15, 2024 License: Apache-2.0

README

animals

This repository contains a collection of API descriptions for a hypothetical division of an enterprise that uses API Hub. This "fauna" division has a number of synthetically generated APIs associated with animals in various stages of their life cycles. All of these APIs will be proxied in a single Apigee X organization and tracked in an API Hub instance alongside APIs from at least one other hypothetical division.

About the APIs

APIs are generated from a list in the animals.yaml file. This list was generated with Bard using a series of questions:

  • "Give me a list of animals, one for each letter of the alphabet"
  • "Can you also include the class, number of legs, weight, and lifespan of each?"
  • "Can you format that as YAML?"

The generated APIs all have the same structure as the Petstore API, but that may change as this example develops.

APIs are stored in the apis directory and can be regenerated by running cmd/generate-animal-apis.

Configuring API Hub

The YAML files in the apis directory include labels, annotations, and artifacts that configure displays in API Hub. For example, here are views corresponding to apis/aardvarks/info.yaml: image image

A sample API server

cmd/animals-server contains a small server for these APIs.

Disclaimer

This demonstration is not an officially supported Google product.

License

Unless otherwise specified, all content is owned by Google, LLC and released with the Apache license.

Directories

Path Synopsis
cmd

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL