proto

module
v0.0.1 Latest Latest
Warning

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

Go to latest
Published: Nov 17, 2023 License: GPL-3.0

README

api

API design documents

API

The centralized API definitions for grpc-go-bootstrap

All API definitions should defined using the protocol buffers and live in the proto/ directory, following the convention of: proto/<service>/<version>/<service>.proto.

The generated code also live in this repo following the convention of <service>/<version>/.

Usage

All commands are accessible via make. Some of the more common ones needed are:

  • deps - Install all the dependences
  • protodeps - Update the third party proto dependencies
  • protos - Generates any *.pb.* files.
Using third party definitions

All third party dependencies should be added to protodeps.toml and downloaded with make protodeps. Files are downloaded to third_party/proto

ToDo

Directories

Path Synopsis
example
v1alpha1
Package examplev1alpha1 is a reverse proxy.
Package examplev1alpha1 is a reverse proxy.

Jump to

Keyboard shortcuts

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