protoc-gen-openapiv2

What it is and what it does

protoc-gen-openapiv2 is a protoc plugin that generates Python code to support gRPC Gateway protoc annotations. It fills a gap in the gRPC Gateway ecosystem by providing the missing Python runtime support that the generated code depends on, specifically providing access to google.api.annotations_pb2 and related protocol buffer definitions through googleapis-common-protos.

The package is designed to work with the new protobuf major version (as of 2022) and requires protobuf as a runtime dependency. It is a code generation tool rather than a runtime library—you install it to run protoc during your build process, not to import and use directly in application code.

Use it for:

• Generate Python gRPC service stubs from proto files that use gRPC Gateway annotations for REST API exposure.
• Build microservices that expose both gRPC and HTTP/REST endpoints from a single proto definition.
• Integrate gRPC Gateway-annotated proto files into Python projects that need OpenAPI v2 support.
• Support proto-based API contracts that require both gRPC and REST client generation.

Worth the install?

AI-flagged interpretation of the facts on this page — verify before relying

Generates Python support code for gRPC Gateway protoc annotations, bridging the gap between gRPC Gateway and Python protobuf stubs.

No. The package is abandoned (last release 2022-12-02, no commits since) and has zero repository stars. While install friction is low and the license is permissive, the lack of maintenance means it will not track upstream gRPC Gateway or protobuf changes. Consider whether a maintained alternative or direct gRPC Gateway integration exists before adopting this.

Install

protoc-gen-openapiv2 on PyPI

pip install protoc-gen-openapiv2

uv add protoc-gen-openapiv2

poetry add protoc-gen-openapiv2

Installing protoc-gen-openapiv2

Before you install

Low install friction with only two runtime dependencies (googleapis-common-protos and protobuf), but the package is abandoned—last release was 2022-12-02 with no subsequent maintenance.

License in practice

Licensed under BSD (permissive), which places no significant restrictions on use or redistribution.

Quickstart

pip install protoc-gen-openapiv2

Then use protoc with the plugin during your build process to generate Python code from proto files with gRPC Gateway annotations.

Requires protobuf and googleapis-common-protos as runtime dependencies; designed for protobuf major version as of 2022.

Verify before relying

• Whether the generated code remains compatible with current protobuf major versions beyond the 2022 release date.
• Whether gRPC Gateway upstream changes since 2022-12-02 have introduced incompatibilities with this generator.
• Active community or alternative maintained forks for this functionality.

Package facts

Evidence: protoc_gen_openapiv2-0.0.1-py3-none-any.whl

Tags

More Build Tools packages