gRPC-Gateway#
Rule |
Description |
---|---|
Generates gRPC-Gateway |
|
Generates gRPC-Gateway OpenAPI v2 |
|
Generates gRPC-Gateway library files |
gateway_grpc_compile#
Generates gRPC-Gateway .go
files
Example#
Full example project can be found here
BUILD.bazel
#
load("@rules_proto_grpc_grpc_gateway//:defs.bzl", "gateway_grpc_compile")
gateway_grpc_compile(
name = "api_gateway_grpc",
protos = ["@rules_proto_grpc_example_protos//:api_proto"],
)
Attributes#
Name |
Type |
Mandatory |
Default |
Description |
---|---|---|---|---|
|
|
true |
List of labels that provide the |
|
|
|
false |
|
Extra options to pass to plugins, as a dict of plugin label -> list of strings. The key * can be used exclusively to apply to all plugins |
|
|
false |
|
The verbosity level. Supported values and results are 0: Show nothing, 1: Show command, 2: Show command and sandbox after running protoc, 3: Show command and sandbox before and after running protoc, 4. Show env, command, expected outputs and sandbox before and after running protoc |
|
|
false |
|
Path to prefix to the generated files in the output directory |
|
|
false |
|
A list of extra command line arguments to pass directly to protoc, not as plugin options |
|
|
false |
|
List of labels that provide extra files to be available during protoc execution |
|
|
false |
|
The output mode for the target. PREFIXED (the default) will output to a directory named by the target within the current package root, NO_PREFIX will output directly to the current package. Using NO_PREFIX may lead to conflicting writes |
Plugins#
gateway_openapiv2_compile#
Generates gRPC-Gateway OpenAPI v2 .json
files
Example#
Full example project can be found here
BUILD.bazel
#
load("@rules_proto_grpc_grpc_gateway//:defs.bzl", "gateway_openapiv2_compile")
gateway_openapiv2_compile(
name = "api_gateway_grpc",
protos = ["@rules_proto_grpc_example_protos//:api_proto"],
)
Attributes#
Name |
Type |
Mandatory |
Default |
Description |
---|---|---|---|---|
|
|
true |
List of labels that provide the |
|
|
|
false |
|
Extra options to pass to plugins, as a dict of plugin label -> list of strings. The key * can be used exclusively to apply to all plugins |
|
|
false |
|
The verbosity level. Supported values and results are 0: Show nothing, 1: Show command, 2: Show command and sandbox after running protoc, 3: Show command and sandbox before and after running protoc, 4. Show env, command, expected outputs and sandbox before and after running protoc |
|
|
false |
|
Path to prefix to the generated files in the output directory |
|
|
false |
|
A list of extra command line arguments to pass directly to protoc, not as plugin options |
|
|
false |
|
List of labels that provide extra files to be available during protoc execution |
|
|
false |
|
The output mode for the target. PREFIXED (the default) will output to a directory named by the target within the current package root, NO_PREFIX will output directly to the current package. Using NO_PREFIX may lead to conflicting writes |
Plugins#
gateway_grpc_library#
Generates gRPC-Gateway library files
Example#
Full example project can be found here
BUILD.bazel
#
load("@rules_proto_grpc_grpc_gateway//:defs.bzl", "gateway_grpc_library")
gateway_grpc_library(
name = "api_gateway_library",
importpath = "github.com/rules-proto-grpc/rules_proto_grpc/grpc-gateway/examples/api",
protos = ["@rules_proto_grpc_example_protos//:api_proto"],
)
Attributes#
Name |
Type |
Mandatory |
Default |
Description |
---|---|---|---|---|
|
|
true |
List of labels that provide the |
|
|
|
false |
|
Extra options to pass to plugins, as a dict of plugin label -> list of strings. The key * can be used exclusively to apply to all plugins |
|
|
false |
|
The verbosity level. Supported values and results are 0: Show nothing, 1: Show command, 2: Show command and sandbox after running protoc, 3: Show command and sandbox before and after running protoc, 4. Show env, command, expected outputs and sandbox before and after running protoc |
|
|
false |
|
Path to prefix to the generated files in the output directory |
|
|
false |
|
A list of extra command line arguments to pass directly to protoc, not as plugin options |
|
|
false |
|
List of labels that provide extra files to be available during protoc execution |
|
|
false |
|
The output mode for the target. PREFIXED (the default) will output to a directory named by the target within the current package root, NO_PREFIX will output directly to the current package. Using NO_PREFIX may lead to conflicting writes |
|
|
false |
|
List of labels to pass as deps attr to underlying lang_library rule |
|
|
false |
|
Importpath for the generated files |