gnostic-go-generator

command module
v0.2.0 Latest Latest
Warning

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

Go to latest
Published: Oct 29, 2020 License: Apache-2.0 Imports: 14 Imported by: 0

README

gnostic Go Generator Plugin

This project contains a gnostic plugin that can be used to generate a Go client library and scaffolding for a Go server for an API with an OpenAPI description.

The plugin can be invoked like this:

gnostic bookstore.json --go-generator-out=bookstore

bookstore is the name of a directory where the generated code will be written. bookstore will also be the package name used for generated code.

By default, both client and server code will be generated. If the gnostic-go-generator binary is also linked from the names gnostic-go-client and gnostic-go-server, then only client or only server code can be generated as follows:

gnostic bookstore.json --go-client-out=bookstore

gnostic bookstore.json --go-server-out=bookstore

For example usage, see the examples/v2.0/bookstore directory.

Disclaimer

This is not an officially supported Google product

Documentation

Overview

gnostic_go_generator is a sample Gnostic plugin that generates Go code that supports an API.

Directories

Path Synopsis
examples
v2.0/bookstore/bookstore
Package bookstore exists to allow this repo to work with recursive go get.
Package bookstore exists to allow this repo to work with recursive go get.
v2.0/sample/sample
Package sample exists to allow this repo to work with recursive go get.
Package sample exists to allow this repo to work with recursive go get.
v2.0/xkcd/xkcd
Package xkcd exists to allow this repo to work with recursive go get.
Package xkcd exists to allow this repo to work with recursive go get.
v3.0/bookstore/bookstore
Package bookstore exists to allow this repo to work with recursive go get.
Package bookstore exists to allow this repo to work with recursive go get.
v3.0/urlshortener/urlshortener
Package urlshortener exists to allow this repo to work with recursive go get.
Package urlshortener exists to allow this repo to work with recursive go get.

Jump to

Keyboard shortcuts

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