grpc-gateway rules

Rule	Description
gateway_grpc_compile	Generates grpc-gateway `.go` files
gateway_openapiv2_compile	Generates grpc-gateway OpenAPI v2 `.json` files
gateway_grpc_library	Generates grpc-gateway library files

`gateway_grpc_compile`

Generates grpc-gateway .go files

`WORKSPACE`

load("@rules_proto_grpc//:repositories.bzl", "bazel_gazelle", "io_bazel_rules_go")  # buildifier: disable=same-origin-load

io_bazel_rules_go()

load("@io_bazel_rules_go//go:deps.bzl", "go_register_toolchains", "go_rules_dependencies")

go_rules_dependencies()

go_register_toolchains(
    version = "1.15.8",
)

bazel_gazelle()

load("@bazel_gazelle//:deps.bzl", "gazelle_dependencies")

gazelle_dependencies()

load("@rules_proto_grpc//grpc-gateway:repositories.bzl", rules_proto_grpc_gateway_repos = "gateway_repos")

rules_proto_grpc_gateway_repos()

load("@grpc_ecosystem_grpc_gateway//:repositories.bzl", "go_repositories")

go_repositories()

`BUILD.bazel`

load("@rules_proto_grpc//grpc-gateway:defs.bzl", "gateway_grpc_compile")

gateway_grpc_compile(
    name = "api_gateway_grpc",
    protos = ["@rules_proto_grpc//grpc-gateway/example/api:api_proto"],
)

Attributes

Name	Type	Mandatory	Default	Description
`protos`	`list<ProtoInfo>`	true	`[]`	List of labels that provide a `ProtoInfo` (such as `rules_proto` `proto_library`)
`options`	`dict<string, list(string)>`	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
`verbose`	`int`	false	`0`	The verbosity level. Supported values and results are 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
`prefix_path`	`string`	false	`""`	Path to prefix to the generated files in the output directory
`extra_protoc_args`	`list<string>`	false	`[]`	A list of extra args to pass directly to protoc, not as plugin options

Plugins

@rules_proto_grpc//grpc-gateway:grpc_gateway_plugin
@rules_proto_grpc//go:grpc_go_plugin
@rules_proto_grpc//go:go_plugin

`gateway_openapiv2_compile`

Generates grpc-gateway OpenAPI v2 .json files

`WORKSPACE`

load("@rules_proto_grpc//:repositories.bzl", "bazel_gazelle", "io_bazel_rules_go")  # buildifier: disable=same-origin-load

io_bazel_rules_go()

load("@io_bazel_rules_go//go:deps.bzl", "go_register_toolchains", "go_rules_dependencies")

go_rules_dependencies()

go_register_toolchains(
    version = "1.15.8",
)

bazel_gazelle()

load("@bazel_gazelle//:deps.bzl", "gazelle_dependencies")

gazelle_dependencies()

load("@rules_proto_grpc//grpc-gateway:repositories.bzl", rules_proto_grpc_gateway_repos = "gateway_repos")

rules_proto_grpc_gateway_repos()

load("@grpc_ecosystem_grpc_gateway//:repositories.bzl", "go_repositories")

go_repositories()

`BUILD.bazel`

load("@rules_proto_grpc//grpc-gateway:defs.bzl", "gateway_openapiv2_compile")

gateway_openapiv2_compile(
    name = "api_gateway_grpc",
    protos = ["@rules_proto_grpc//grpc-gateway/example/api:api_proto"],
)

Attributes

Name	Type	Mandatory	Default	Description
`protos`	`list<ProtoInfo>`	true	`[]`	List of labels that provide a `ProtoInfo` (such as `rules_proto` `proto_library`)
`options`	`dict<string, list(string)>`	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
`verbose`	`int`	false	`0`	The verbosity level. Supported values and results are 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
`prefix_path`	`string`	false	`""`	Path to prefix to the generated files in the output directory
`extra_protoc_args`	`list<string>`	false	`[]`	A list of extra args to pass directly to protoc, not as plugin options

Plugins

@rules_proto_grpc//grpc-gateway:openapiv2_plugin

`gateway_grpc_library`

Generates grpc-gateway library files

`WORKSPACE`

load("@rules_proto_grpc//:repositories.bzl", "bazel_gazelle", "io_bazel_rules_go")  # buildifier: disable=same-origin-load

io_bazel_rules_go()

load("@io_bazel_rules_go//go:deps.bzl", "go_register_toolchains", "go_rules_dependencies")

go_rules_dependencies()

go_register_toolchains(
    version = "1.15.8",
)

bazel_gazelle()

load("@bazel_gazelle//:deps.bzl", "gazelle_dependencies")

gazelle_dependencies()

load("@rules_proto_grpc//grpc-gateway:repositories.bzl", rules_proto_grpc_gateway_repos = "gateway_repos")

rules_proto_grpc_gateway_repos()

load("@grpc_ecosystem_grpc_gateway//:repositories.bzl", "go_repositories")

go_repositories()

`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//grpc-gateway/example/api:api_proto"],
)

Attributes

Name	Type	Mandatory	Default	Description
`protos`	`list<ProtoInfo>`	true	`[]`	List of labels that provide a `ProtoInfo` (such as `rules_proto` `proto_library`)
`options`	`dict<string, list(string)>`	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
`verbose`	`int`	false	`0`	The verbosity level. Supported values and results are 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
`prefix_path`	`string`	false	`""`	Path to prefix to the generated files in the output directory
`extra_protoc_args`	`list<string>`	false	`[]`	A list of extra args to pass directly to protoc, not as plugin options
`deps`	`list<Label/string>`	false	`[]`	List of labels to pass as deps attr to underlying lang_library rule
`importpath`	`string`	false	`None`	Importpath for the generated files