Import "google/api/annotations.proto" was not found or had errors. How do I add it as a dependency?

Question

Following the docs on how to set up a gRPC gateway, I find myself stuck at step four of generating the grpc gateway.

Namely, things fall apart when the following line is added:

import "google/api/annotations.proto";

The documentation says You will need to provide the required third party protobuf files to the protoc compiler - but not actually how do do so.

How do I add google/api/annotations.proto as a dependency?

score 13 · Accepted Answer · edited Jul 31 '21 at 13:01

13

I solved it one way by adding third party google apis and its content to the root of my project.

Feels wrong, but apparently this is encouraged

edited Jul 31 '21 at 13:01

Max R.

811
1
13
31

answered Feb 12 '21 at 09:42

cbll

6,499
26
74
117

4

https://grpc-ecosystem.github.io/grpc-gateway/docs/tutorials/adding_annotations/#using-protoc – kangkyu Mar 17 '21 at 23:35

score 6 · Answer 2 · answered Aug 31 '21 at 17:53

6

I had the same issue and i resolved it following this structure :

proto
├── google
│   └── api
│       ├── annotations.proto
│       └── http.proto
└── helloworld
    └── hello_world.proto

and run the command :

protoc -I ./proto \
   --go_out ./proto --go_opt paths=source_relative \
   --go-grpc_out ./proto --go-grpc_opt paths=source_relative \
   --grpc-gateway_out ./proto --grpc-gateway_opt paths=source_relative \
   ./proto/helloworld/hello_world.proto

answered Aug 31 '21 at 17:53

Slimane amiar

934
12
27

1

Did you download those google's proto files from grpc repository manually ? – Abdurrahman I. Jan 27 '22 at 12:42
Important if you don't have the "google/api" dir at the root of your project and you are managing it another way. – Justin Mar 14 '22 at 13:50

score 2 · Answer 3 · answered Jul 28 '21 at 13:25

2

I solved it with only copying annotations.proto and http.proto in the main proto:

import "Proto/google/api/annotations.proto";

and inside annotations.proto

import "Proto/google/api/http.proto";

and my folders look like this:

answered Jul 28 '21 at 13:25

AJ AJ

187
2
12

1

doesn't work for me – jenkizenki Oct 28 '21 at 21:41

Igor · Answer 4 · 2021-11-03T06:46:03.177

If you are using protoc to generate stubs, you need to ensure the required dependencies are available to the compiler at compile time. These can be found by manually cloning and copying the relevant files from the googleapis repository, and providing them to protoc when running. The files you will need are:

google/api/annotations.proto
google/api/field_behaviour.proto
google/api/http.proto
google/api/httpbody.proto

from grpc-gateway

for example run in project root git submodule add https://github.com/googleapis/googleapis to get actual version

score 0 · Answer 5 · answered Dec 22 '22 at 20:00

Sometimes this error occurs when we run protoc . try to import the dependency when running the protoc command.

for this type of structure use

>protoc -I . -I pb/google/api --go_out . --go_opt paths=source_relative --go-grpc_out . --go-grpc_opt paths=source_relative --grpc-gateway_out . --grpc-gateway_opt paths=source_relative ./pb/*.proto

Import "google/api/annotations.proto" was not found or had errors. How do I add it as a dependency?

5 Answers5

Linked