Skip to content

Commit 87316b9

Browse files
sudorandomsudorandom
committed
feat: add path-prefix to add a custome prefix to each http path
1 parent ece8d2b commit 87316b9

File tree

11 files changed

+512
-4
lines changed

11 files changed

+512
-4
lines changed

‎README.md

+4-3
Original file line numberDiff line numberDiff line change
@@ -112,12 +112,13 @@ protoc-gen-connect-openapi also has support for the [OpenAPI v3 annotations](htt
112112
| content-types | `json;proto` | Semicolon-separated content types to generate requests/repsonses |
113113
| debug | - | Emit debug logs |
114114
| format | `yaml` or `json` | Which format to use for the OpenAPI file, defaults to `yaml`. |
115-
| include-number-enum-values | - | Include number enum values beside the string versions, defaults to only showing strings |
116115
| ignore-googleapi-http | - | Ignore `google.api.http` options on methods when generating openapi specs |
116+
| include-number-enum-values | - | Include number enum values beside the string versions, defaults to only showing strings |
117117
| path | `{filepath}` | Output filepath, defaults to per-protofile output if not given. |
118+
| path-prefix | - | Prefixes the given string to the beginning of each HTTP path. |
118119
| proto | - | Generate requests/repsonses with the protobuf content type |
120+
| services | - | Filter which services have OpenAPI spec generated. The default is all services. Comma-separated, uses the full path of the service "[package name].[service name]" |
119121
| trim-unused-types | - | Remove types that aren't references from any method request or response. |
120122
| with-proto-annotations | - | Add protobuf type annotations to the end of descriptions so users know the protobuf type that the field converts to. |
121123
| with-proto-names | - | Use protobuf field names instead of the camelCase JSON names for property names. |
122-
| with-streaming | - | Generate OpenAPI for client/server/bidirectional streaming RPCs (can be messy). |
123-
| services | - | Filter which services have OpenAPI spec generated. The default is all services. Comma-separated, uses the full path of the service "[package name].[service name]" |
124+
| with-streaming | - | Generate OpenAPI for client/server/bidirectional streaming RPCs (can be messy). |

‎converter/converter.go

+8
Original file line numberDiff line numberDiff line change
@@ -210,3 +210,11 @@ func WithServiceDescriptions(enabled bool) Option {
210210
return nil
211211
}
212212
}
213+
214+
// WithPathPrefix prepends a given string to each HTTP path.
215+
func WithPathPrefix(prefix string) Option {
216+
return func(g *generator) error {
217+
g.options.PathPrefix = prefix
218+
return nil
219+
}
220+
}

‎internal/converter/converter_test.go

+1
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@ import (
2828
var scenarios = []Scenario{
2929
{Name: "standard", Options: "allow-get,with-streaming,with-service-descriptions"},
3030
{Name: "proto_names", Options: "with-proto-names"},
31+
{Name: "path_prefix", Options: "path-prefix=/testing/1234"},
3132
{Name: "with_proto_annotations", Options: "with-proto-annotations"},
3233
{Name: "trim_unused_type", Options: "trim-unused-types"},
3334
{Name: "with_base", Options: "base=testdata/with_base/base.yaml,trim-unused-types"},

‎internal/converter/googleapi/paths.go

+2-1
Original file line numberDiff line numberDiff line change
@@ -179,7 +179,8 @@ func httpRuleToPathMap(opts options.Options, md protoreflect.MethodDescriptor, r
179179
for _, binding := range rule.AdditionalBindings {
180180
pathMap := httpRuleToPathMap(opts, md, binding)
181181
for pair := pathMap.First(); pair != nil; pair = pair.Next() {
182-
paths.Set(pair.Key(), pair.Value())
182+
path := util.MakePath(opts, pair.Key())
183+
paths.Set(path, pair.Value())
183184
}
184185
}
185186
return paths

‎internal/converter/options/options.go

+4
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,8 @@ type Options struct {
2828
WithProtoNames bool
2929
// Path is the output OpenAPI path.
3030
Path string
31+
// PathPrefix is a prefix that is prepended to every HTTP path.
32+
PathPrefix string
3133
// TrimUnusedTypes will remove types that aren't referenced by a service.
3234
TrimUnusedTypes bool
3335
// WithProtoAnnotations will add some protobuf annotations for descriptions
@@ -111,6 +113,8 @@ func FromString(s string) (Options, error) {
111113
}
112114
case strings.HasPrefix(param, "path="):
113115
opts.Path = param[5:]
116+
case strings.HasPrefix(param, "path-prefix="):
117+
opts.PathPrefix = param[12:]
114118
case strings.HasPrefix(param, "format="):
115119
format := param[7:]
116120
switch format {

‎internal/converter/paths.go

+1
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@ func addPathItemsFromFile(opts options.Options, fd protoreflect.FileDescriptor,
2727

2828
// Helper function to update or set path items
2929
addPathItem := func(path string, newItem *v3.PathItem) {
30+
path = util.MakePath(opts, path)
3031
if existing, ok := paths.PathItems.Get(path); !ok {
3132
paths.PathItems.Set(path, newItem)
3233
} else {

‎internal/converter/testdata/fileset.binpb

1.18 KB
Binary file not shown.

‎internal/converter/testdata/path_prefix/output/path_prefixes.openapi.json

+268
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,268 @@
1+
{
2+
"openapi": "3.1.0",
3+
"info": {
4+
"title": "path_prefixes"
5+
},
6+
"paths": {
7+
"/testing/1234/path_prefixes.Greeter/SayHello": {
8+
"post": {
9+
"tags": [
10+
"path_prefixes.Greeter"
11+
],
12+
"summary": "SayHello",
13+
"description": "Sends a greeting",
14+
"operationId": "path_prefixes.Greeter.SayHello",
15+
"parameters": [
16+
{
17+
"name": "Connect-Protocol-Version",
18+
"in": "header",
19+
"required": true,
20+
"schema": {
21+
"$ref": "#/components/schemas/connect-protocol-version"
22+
}
23+
},
24+
{
25+
"name": "Connect-Timeout-Ms",
26+
"in": "header",
27+
"schema": {
28+
"$ref": "#/components/schemas/connect-timeout-header"
29+
}
30+
}
31+
],
32+
"requestBody": {
33+
"content": {
34+
"application/json": {
35+
"schema": {
36+
"$ref": "#/components/schemas/path_prefixes.HelloRequest"
37+
}
38+
}
39+
},
40+
"required": true
41+
},
42+
"responses": {
43+
"default": {
44+
"description": "Error",
45+
"content": {
46+
"application/json": {
47+
"schema": {
48+
"$ref": "#/components/schemas/connect.error"
49+
}
50+
}
51+
}
52+
},
53+
"200": {
54+
"description": "Success",
55+
"content": {
56+
"application/json": {
57+
"schema": {
58+
"$ref": "#/components/schemas/path_prefixes.HelloReply"
59+
}
60+
}
61+
}
62+
}
63+
}
64+
}
65+
},
66+
"/testing/1234/path_prefixes.Greeter/WriteHello": {
67+
"post": {
68+
"tags": [
69+
"path_prefixes.Greeter"
70+
],
71+
"summary": "WriteHello",
72+
"description": "Writes a greeting (has side effects)",
73+
"operationId": "path_prefixes.Greeter.WriteHello",
74+
"parameters": [
75+
{
76+
"name": "Connect-Protocol-Version",
77+
"in": "header",
78+
"required": true,
79+
"schema": {
80+
"$ref": "#/components/schemas/connect-protocol-version"
81+
}
82+
},
83+
{
84+
"name": "Connect-Timeout-Ms",
85+
"in": "header",
86+
"schema": {
87+
"$ref": "#/components/schemas/connect-timeout-header"
88+
}
89+
}
90+
],
91+
"requestBody": {
92+
"content": {
93+
"application/json": {
94+
"schema": {
95+
"$ref": "#/components/schemas/path_prefixes.HelloRequest"
96+
}
97+
}
98+
},
99+
"required": true
100+
},
101+
"responses": {
102+
"default": {
103+
"description": "Error",
104+
"content": {
105+
"application/json": {
106+
"schema": {
107+
"$ref": "#/components/schemas/connect.error"
108+
}
109+
}
110+
}
111+
},
112+
"200": {
113+
"description": "Success",
114+
"content": {
115+
"application/json": {
116+
"schema": {
117+
"$ref": "#/components/schemas/path_prefixes.HelloReply"
118+
}
119+
}
120+
}
121+
}
122+
}
123+
}
124+
},
125+
"/testing/1234/.well-known/jwks.json": {
126+
"get": {
127+
"tags": [
128+
"path_prefixes.Greeter"
129+
],
130+
"summary": "Foo",
131+
"operationId": "path_prefixes.Greeter.Foo",
132+
"responses": {
133+
"default": {
134+
"description": "Error",
135+
"content": {
136+
"application/json": {
137+
"schema": {
138+
"$ref": "#/components/schemas/connect.error"
139+
}
140+
}
141+
}
142+
},
143+
"200": {
144+
"description": "Success",
145+
"content": {
146+
"application/json": {
147+
"schema": {
148+
"$ref": "#/components/schemas/google.protobuf.Empty"
149+
}
150+
}
151+
}
152+
}
153+
}
154+
}
155+
}
156+
},
157+
"components": {
158+
"schemas": {
159+
"google.protobuf.Empty": {
160+
"type": "object",
161+
"description": "A generic empty message that you can re-use to avoid defining duplicated\n empty messages in your APIs. A typical example is to use it as the request\n or the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }"
162+
},
163+
"path_prefixes.HelloReply": {
164+
"type": "object",
165+
"properties": {
166+
"message": {
167+
"type": "string",
168+
"title": "message"
169+
}
170+
},
171+
"title": "HelloReply",
172+
"additionalProperties": false,
173+
"description": "The response message containing the greetings"
174+
},
175+
"path_prefixes.HelloRequest": {
176+
"type": "object",
177+
"properties": {
178+
"name": {
179+
"type": "string",
180+
"title": "name"
181+
}
182+
},
183+
"title": "HelloRequest",
184+
"additionalProperties": false,
185+
"description": "The request message containing the user's name."
186+
},
187+
"connect-protocol-version": {
188+
"type": "number",
189+
"title": "Connect-Protocol-Version",
190+
"enum": [
191+
1
192+
],
193+
"description": "Define the version of the Connect protocol",
194+
"const": 1
195+
},
196+
"connect-timeout-header": {
197+
"type": "number",
198+
"title": "Connect-Timeout-Ms",
199+
"description": "Define the timeout, in ms"
200+
},
201+
"connect.error": {
202+
"type": "object",
203+
"properties": {
204+
"code": {
205+
"type": "string",
206+
"examples": [
207+
"not_found"
208+
],
209+
"enum": [
210+
"canceled",
211+
"unknown",
212+
"invalid_argument",
213+
"deadline_exceeded",
214+
"not_found",
215+
"already_exists",
216+
"permission_denied",
217+
"resource_exhausted",
218+
"failed_precondition",
219+
"aborted",
220+
"out_of_range",
221+
"unimplemented",
222+
"internal",
223+
"unavailable",
224+
"data_loss",
225+
"unauthenticated"
226+
],
227+
"description": "The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code]."
228+
},
229+
"message": {
230+
"type": "string",
231+
"description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client."
232+
},
233+
"detail": {
234+
"$ref": "#/components/schemas/google.protobuf.Any"
235+
}
236+
},
237+
"title": "Connect Error",
238+
"additionalProperties": true,
239+
"description": "Error type returned by Connect: https://connectrpc.com/docs/go/errors/#http-representation"
240+
},
241+
"google.protobuf.Any": {
242+
"type": "object",
243+
"properties": {
244+
"type": {
245+
"type": "string"
246+
},
247+
"value": {
248+
"type": "string",
249+
"format": "binary"
250+
},
251+
"debug": {
252+
"type": "object",
253+
"additionalProperties": true
254+
}
255+
},
256+
"additionalProperties": true,
257+
"description": "Contains an arbitrary serialized message along with a @type that describes the type of the serialized message."
258+
}
259+
}
260+
},
261+
"security": [],
262+
"tags": [
263+
{
264+
"name": "path_prefixes.Greeter",
265+
"description": "The greeting service definition."
266+
}
267+
]
268+
}

0 commit comments

Comments
 (0)