Repository navigation
Expand file tree
/
Copy pathcodegen.go
More file actions
2222 lines (1993 loc) · 74.8 KB
/
Copy pathcodegen.go
File metadata and controls
2222 lines (1993 loc) · 74.8 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
// Copyright 2019 DeepMap, Inc.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package codegen
import (
"bufio"
"bytes"
"context"
"embed"
"errors"
"fmt"
"go/scanner"
"io"
"io/fs"
"maps"
"net/http"
"os"
"regexp"
"runtime/debug"
"slices"
"strconv"
"strings"
"text/template"
"time"
"github.com/getkin/kin-openapi/openapi3"
"golang.org/x/tools/imports"
"github.com/oapi-codegen/oapi-codegen/v2/pkg/util"
)
// Embed the templates directory
//
//go:embed templates
var templates embed.FS
// globalState stores all global state. Please don't put global state anywhere
// else so that we can easily track it.
var globalState struct {
options Configuration
spec *openapi3.T
// is31 is true when the loaded spec declares OpenAPI version >=3.1.
// All version-aware behavior (e.g. nullable detection, webhook emission)
// reads from this field. Do NOT expose this field to templates --
// templates are version-blind and consume pre-computed derived fields
// (e.g. Schema.Nullable) populated by version-aware Go helpers.
// Adding `is31` to TemplateFunctions or branching on the OpenAPI
// version inside a template is a layering violation.
is31 bool
importMapping importMap
// initialismsMap stores initialisms as "lower(initialism) -> initialism" map.
// List of initialisms was taken from https://staticcheck.io/docs/configuration/options/#initialisms.
initialismsMap map[string]string
// typeMapping is the merged type mapping (defaults + user overrides).
typeMapping TypeMapping
// resolvedNames maps schema path strings (e.g. "components/schemas/Pet")
// to their resolved Go type names, assigned by the multi-pass name resolver.
resolvedNames map[string]string
// resolvedClientWrapperNames maps operationID to the resolved Go type name
// for client response wrapper types (e.g., "createChatCompletion" -> "CreateChatCompletionResponseWrapper").
resolvedClientWrapperNames map[string]string
// streamingContentTypeRegexes are the compiled regexes (defaults + user)
// used by ResponseContentDefinition.IsStreamingContentType.
streamingContentTypeRegexes []*regexp.Regexp
// contentTypeNameTags is the compiled output-options.content-types
// mapping, resolving media types to user-configured short names for use
// in generated type names. Nil-safe: a nil matcher matches nothing.
contentTypeNameTags *contentTypeNameTags
// schemaFieldTagGenerator renders struct tags for schema property
// fields (defaults + output-options.struct-tags, including the legacy
// yaml-tags injection). Built in Generate; lazily built for direct
// callers via schemaFieldTagGenerator().
schemaFieldTagGenerator *structTagGenerator
// paramFieldTagGenerator renders struct tags for path parameter fields
// on strict RequestObject structs; identical to the schema generator
// except the legacy yaml-tags flag does not apply.
paramFieldTagGenerator *structTagGenerator
}
// goImport represents a go package to be imported in the generated code
type goImport struct {
Name string // package name
Path string // package path
}
// String returns a go import statement
func (gi goImport) String() string {
if gi.Name != "" {
return fmt.Sprintf("%s %q", gi.Name, gi.Path)
}
return fmt.Sprintf("%q", gi.Path)
}
// importMap maps external OpenAPI specifications files/urls to external go packages
type importMap map[string]goImport
// importMappingCurrentPackage allows an Import Mapping to map to the current package, rather than an external package.
// This allows users to split their OpenAPI specification across multiple files, but keep them in the same package, which can reduce a bit of the overhead for users.
// We use `-` to indicate that this is a bit of a special case
const importMappingCurrentPackage = "-"
// GoImports returns a slice of go import statements, sorted so that the
// generated output is deterministic even when it is not passed through gofmt
// (output-options.skip-fmt), which would otherwise sort the import block.
func (im importMap) GoImports() []string {
goImports := make([]string, 0, len(im))
for _, v := range im {
if v.Path == importMappingCurrentPackage {
continue
}
goImports = append(goImports, v.String())
}
slices.Sort(goImports)
return goImports
}
func constructImportMapping(importMapping map[string]string) importMap {
var (
pathToImport = importMap{}
result = importMap{}
)
{
packagePaths := slices.Collect(maps.Values(importMapping))
slices.Sort(packagePaths)
for _, packagePath := range packagePaths {
if _, ok := pathToImport[packagePath]; !ok && packagePath != importMappingCurrentPackage {
split := strings.Split(packagePath, " ")
if len(split) == 2 {
// if we have 2 parts, we assume both the package name and path are provided, and we use them as is
pathToImport[packagePath] = goImport{
Name: split[0],
Path: split[1],
}
} else {
// otherwise, we auto-generate a package name based on the order of the imports, to ensure deterministic output
pathToImport[packagePath] = goImport{
Name: fmt.Sprintf("externalRef%d", len(pathToImport)),
Path: packagePath,
}
}
}
}
}
for specPath, packagePath := range importMapping {
if packagePath == importMappingCurrentPackage {
result[specPath] = goImport{
Path: importMappingCurrentPackage,
}
} else {
result[specPath] = pathToImport[packagePath]
}
}
return result
}
// Generate uses the Go templating engine to generate all of our server wrappers from
// the descriptions we've built up above from the schema objects.
// opts defines
func Generate(spec *openapi3.T, opts Configuration) (string, error) {
// Validate() already rejects these, but Generate is also called directly.
if _, err := opts.Compatibility.schemaMergingVersion(); err != nil {
return "", fmt.Errorf("invalid `compatibility` configuration: %w", err)
}
// This is global state
globalState.options = opts
globalState.spec = spec
globalState.is31 = spec.IsOpenAPI31OrLater()
globalState.importMapping = constructImportMapping(opts.ImportMapping)
if opts.OutputOptions.TypeMapping != nil {
globalState.typeMapping = DefaultTypeMapping.Merge(*opts.OutputOptions.TypeMapping)
} else {
globalState.typeMapping = DefaultTypeMapping
}
// Build the struct tag generators eagerly so invalid user templates in
// output-options.struct-tags are reported as errors instead of being
// skipped. Assigning here also resets any state from a prior Generate.
schemaTagGen, err := newStructTagGenerator(
defaultStructTagsConfig(opts.OutputOptions.EnableYamlTags).Merge(opts.OutputOptions.StructTags))
if err != nil {
return "", fmt.Errorf("error in output-options.struct-tags: %w", err)
}
globalState.schemaFieldTagGenerator = schemaTagGen
paramTagGen, err := newStructTagGenerator(
defaultStructTagsConfig(false).Merge(opts.OutputOptions.StructTags))
if err != nil {
return "", fmt.Errorf("error in output-options.struct-tags: %w", err)
}
globalState.paramFieldTagGenerator = paramTagGen
filterOperationsByTag(spec, opts)
filterOperationsByOperationID(spec, opts)
if !opts.OutputOptions.SkipPrune {
pruneUnusedComponents(spec)
}
// Reject spec values that cannot be represented in the generated Go source
// (names, media types, enum values, extension hints containing quotes,
// backticks, or control characters). Run after filtering/pruning so only
// values that will actually be emitted are considered.
if err := validateSpec(spec, allOfMergesUnions()); err != nil {
return "", err
}
if opts.Generate.StdHTTPServer {
if err := ValidateStdHTTPPaths(spec); err != nil {
return "", err
}
}
// if we are provided an override for the response type suffix update it
if opts.OutputOptions.ResponseTypeSuffix != "" {
responseTypeSuffix = opts.OutputOptions.ResponseTypeSuffix
}
if globalState.options.OutputOptions.ClientTypeName == "" {
globalState.options.OutputOptions.ClientTypeName = defaultClientTypeName
}
nameNormalizerFunction := NameNormalizerFunction(opts.OutputOptions.NameNormalizer)
nameNormalizer = NameNormalizers[nameNormalizerFunction]
if nameNormalizer == nil {
return "", fmt.Errorf(`the name-normalizer option %v could not be found among options %q`,
opts.OutputOptions.NameNormalizer, NameNormalizers.Options())
}
if nameNormalizerFunction != NameNormalizerFunctionToCamelCaseWithInitialisms && len(opts.OutputOptions.AdditionalInitialisms) > 0 {
return "", fmt.Errorf("you have specified `additional-initialisms`, but the `name-normalizer` is not set to `ToCamelCaseWithInitialisms`. Please specify `name-normalizer: ToCamelCaseWithInitialisms` or remove the `additional-initialisms` configuration")
}
globalState.initialismsMap = makeInitialismsMap(opts.OutputOptions.AdditionalInitialisms)
// Compile streaming-content-type patterns (defaults merged with user-supplied).
// Validate() already caught syntax errors, but surface any regression here too.
streamingRegexes, err := compileStreamingContentTypes(opts.OutputOptions.StreamingContentTypes)
if err != nil {
return "", err
}
globalState.streamingContentTypeRegexes = streamingRegexes
// Compile the content-types short name mapping. Validate() already caught
// syntax errors, but surface any regression here too.
contentTypeTags, err := compileContentTypeNameTags(opts.OutputOptions.ContentTypes)
if err != nil {
return "", err
}
globalState.contentTypeNameTags = contentTypeTags
// Multi-pass name resolution: gather all schemas, then resolve names globally.
// Only enabled when resolve-type-name-collisions is set.
if opts.OutputOptions.ResolveTypeNameCollisions {
gathered := GatherSchemas(spec, opts)
globalState.resolvedNames = ResolveNames(gathered)
// Build a separate operationID -> wrapper name lookup for genResponseTypeName.
// Keys must use the normalized operationID (via nameNormalizer) because
// OperationDefinition.OperationId is normalized before templates run.
globalState.resolvedClientWrapperNames = make(map[string]string)
for _, gs := range gathered {
if gs.Context == ContextClientResponseWrapper && gs.OperationID != "" {
if name, ok := globalState.resolvedNames[gs.Path.String()]; ok {
normalizedOpID := nameNormalizer(gs.OperationID)
globalState.resolvedClientWrapperNames[normalizedOpID] = name
}
}
}
} else {
globalState.resolvedNames = nil
globalState.resolvedClientWrapperNames = nil
}
// This creates the golang templates text package
TemplateFunctions["opts"] = func() Configuration { return globalState.options }
t := template.New("oapi-codegen").Funcs(TemplateFunctions)
// This parses all of our own template files into the template object
// above
err = LoadTemplates(templates, t)
if err != nil {
return "", fmt.Errorf("error parsing oapi-codegen templates: %w", err)
}
// load user-provided templates. Will Override built-in versions.
for name, template := range opts.OutputOptions.UserTemplates {
utpl := t.New(name)
txt, err := GetUserTemplateText(template)
if err != nil {
return "", fmt.Errorf("error loading user-provided template %q: %w", name, err)
}
_, err = utpl.Parse(txt)
if err != nil {
return "", fmt.Errorf("error parsing user-provided template %q: %w", name, err)
}
}
// Build per-framework clones of the base tree, layering each framework's
// hook overrides over the shared server-*.tmpl skeletons. Must happen after
// user templates are parsed (so user overrides propagate into the clones)
// and before any template is executed (Clone forbids cloning an executed
// tree).
serverTemplates, err := buildServerTemplates(templates, t)
if err != nil {
return "", fmt.Errorf("error building per-framework server templates: %w", err)
}
ops, err := OperationDefinitions(spec)
if err != nil {
return "", fmt.Errorf("error creating operation definitions: %w", err)
}
// Webhooks (OpenAPI 3.1+) flow through the same OperationDefinition
// shape as paths but render via webhook-specific templates. The
// gather walks swagger.Webhooks unconditionally -- the map is only
// populated by kin-openapi for 3.1+ documents, so 3.0 specs return
// an empty slice naturally. allOps is used for cross-cutting passes
// (type defs, import gathering); ops and webhookOps are passed
// separately to path-vs-webhook template generators.
webhookOps, err := WebhookOperationDefinitions(spec)
if err != nil {
return "", fmt.Errorf("error creating webhook operation definitions: %w", err)
}
// Callbacks (OpenAPI 3.0+) are nested under path operations. Like
// webhooks they render via initiator/receiver templates, but they
// are NOT version-gated -- callbacks have been part of the spec
// since 3.0. Gather is no-op for specs without any callbacks.
callbackOps, err := CallbackOperationDefinitions(spec)
if err != nil {
return "", fmt.Errorf("error creating callback operation definitions: %w", err)
}
allOps := append(append(append([]OperationDefinition{}, ops...), webhookOps...), callbackOps...)
xGoTypeImports, err := OperationImports(allOps)
if err != nil {
return "", fmt.Errorf("error getting operation imports: %w", err)
}
// Type and constant emission is gated by Generate.Models. Both
// component-derived types (from #/components) and op-derived types
// (Params/RequestBody/hoisted-ResponseBody) flow through this gate
// today; that conflation is historical but kept for backwards
// compatibility (changing it would alter the symbols emitted by
// `models: true`-alone configs and break downstream code in the wild).
var typeDefinitions, constantDefinitions string
if opts.Generate.Models {
componentTypes, err := collectComponentTypes(t, spec, opts.OutputOptions.ExcludeSchemas)
if err != nil {
return "", fmt.Errorf("error collecting component types: %w", err)
}
componentDecls, err := GenerateTypes(t, componentTypes)
if err != nil {
return "", fmt.Errorf("error generating code for type definitions: %w", err)
}
// Pass allOps (regular paths + webhooks + callbacks) so op-derived
// types from webhook/callback operations are emitted too.
opTypes, err := collectOperationTypes(allOps)
if err != nil {
return "", fmt.Errorf("error collecting operation types: %w", err)
}
if err := checkOperationTypeNames(componentTypes, allOps); err != nil {
return "", fmt.Errorf("error generating code for type definitions: %w", err)
}
opDecls, err := GenerateTypesForOperations(t, allOps)
if err != nil {
return "", fmt.Errorf("error generating Go types for operations: %w", err)
}
constantDefinitions, err = GenerateConstants(t, spec)
if err != nil {
return "", fmt.Errorf("error generating constants: %w", err)
}
imprts, err := GetTypeDefinitionsImports(spec, opts.OutputOptions.ExcludeSchemas)
if err != nil {
return "", fmt.Errorf("error getting type definition imports: %w", err)
}
maps.Copy(xGoTypeImports, imprts)
// Boilerplate (enum Valid(), union accessors, additionalProperties
// marshalers) scans the union of all declared types so methods are
// emitted for inline types living inside operations too.
allEmitted := slices.Concat(componentTypes, opTypes)
enumsOut, allOfOut, unionOut, unionAndAdditionalOut, err := renderBoilerplate(t, allEmitted)
if err != nil {
return "", err
}
// Preserve historical concatenation order:
// enums, component decls, op decls, allOf, union, union+additional.
typeDefinitions = strings.Join([]string{enumsOut, componentDecls, opDecls, allOfOut, unionOut, unionAndAdditionalOut}, "")
}
var serverURLsDefinitions string
if opts.Generate.ServerURLs {
// Server-URL enum-typed variables are routed through the same
// typedef.tmpl + constants.tmpl pipelines as any other
// enum-bearing schema, so they get matching `type X string`,
// `const ( … )` block, and `Valid()` method. We do this here
// (rather than in collectComponentTypes) so the types are
// emitted even when `generate.models` is disabled.
if err := ValidateServerURLs(spec); err != nil {
return "", err
}
serverURLEnumTypes, err := BuildServerURLTypeDefinitions(spec)
if err != nil {
return "", fmt.Errorf("error generating Go types for server URL variables: %w", err)
}
serverURLEnumTypeDecls, err := GenerateTypes(t, serverURLEnumTypes)
if err != nil {
return "", fmt.Errorf("error generating type declarations for server URL variables: %w", err)
}
serverURLEnumConstants, err := GenerateEnums(t, serverURLEnumTypes)
if err != nil {
return "", fmt.Errorf("error generating enums for server URL variables: %w", err)
}
serverURLsBody, err := GenerateServerURLs(t, spec)
if err != nil {
return "", fmt.Errorf("error generating Server URLs: %w", err)
}
serverURLsDefinitions = serverURLEnumTypeDecls + serverURLEnumConstants + serverURLsBody
}
var irisServerOut string
if opts.Generate.IrisServer {
irisServerOut, err = GenerateIrisServer(serverTemplates["iris"], ops)
if err != nil {
return "", fmt.Errorf("error generating Go handlers for Paths: %w", err)
}
}
var echoServerOut string
if opts.Generate.EchoServer {
echoServerOut, err = GenerateEchoServer(serverTemplates["echo"], ops)
if err != nil {
return "", fmt.Errorf("error generating Go handlers for Paths: %w", err)
}
}
var echo5ServerOut string
if opts.Generate.Echo5Server {
echo5ServerOut, err = GenerateEcho5Server(serverTemplates["echo5"], ops)
if err != nil {
return "", fmt.Errorf("error generating Go handlers for Paths: %w", err)
}
}
var chiServerOut string
if opts.Generate.ChiServer {
chiServerOut, err = GenerateChiServer(serverTemplates["chi"], ops)
if err != nil {
return "", fmt.Errorf("error generating Go handlers for Paths: %w", err)
}
}
var fiberServerOut string
if opts.Generate.FiberServer {
fiberServerOut, err = GenerateFiberServer(serverTemplates["fiber"], ops)
if err != nil {
return "", fmt.Errorf("error generating Go handlers for Paths: %w", err)
}
}
var fiberV3ServerOut string
if opts.Generate.FiberV3Server {
fiberV3ServerOut, err = GenerateFiberV3Server(serverTemplates["fiberv3"], ops)
if err != nil {
return "", fmt.Errorf("error generating Go handlers for Paths: %w", err)
}
}
var ginServerOut string
if opts.Generate.GinServer {
ginServerOut, err = GenerateGinServer(serverTemplates["gin"], ops)
if err != nil {
return "", fmt.Errorf("error generating Go handlers for Paths: %w", err)
}
}
var gorillaServerOut string
if opts.Generate.GorillaServer {
gorillaServerOut, err = GenerateGorillaServer(serverTemplates["gorilla"], ops)
if err != nil {
return "", fmt.Errorf("error generating Go handlers for Paths: %w", err)
}
}
var stdHTTPServerOut string
if opts.Generate.StdHTTPServer {
stdHTTPServerOut, err = GenerateStdHTTPServer(t, ops)
if err != nil {
return "", fmt.Errorf("error generating Go handlers for Paths: %w", err)
}
}
var strictServerOut string
if opts.Generate.Strict {
var responses []ResponseDefinition
if spec.Components != nil {
responses, err = GenerateResponseDefinitions("", spec.Components.Responses, "")
if err != nil {
return "", fmt.Errorf("error generation response definitions for schema: %w", err)
}
}
strictServerResponses, err := GenerateStrictResponses(t, responses)
if err != nil {
return "", fmt.Errorf("error generation response definitions for schema: %w", err)
}
strictServerOut, err = GenerateStrictServer(t, serverTemplates, ops, opts)
if err != nil {
return "", fmt.Errorf("error generating Go handlers for Paths: %w", err)
}
strictServerOut = strictServerResponses + strictServerOut
}
var clientOut string
if opts.Generate.Client {
clientOut, err = GenerateClient(t, ops)
if err != nil {
return "", fmt.Errorf("error generating client: %w", err)
}
}
var clientWithResponsesOut string
if opts.Generate.Client {
clientWithResponsesOut, err = GenerateClientWithResponses(t, ops)
if err != nil {
return "", fmt.Errorf("error generating client with responses: %w", err)
}
}
// Webhook initiator pairs with the path Client. Emitted only when
// Generate.Client is on AND the spec has webhooks (3.1+).
var webhookInitiatorOut string
if opts.Generate.Client && len(webhookOps) > 0 {
webhookInitiatorOut, err = GenerateWebhookInitiator(t, webhookOps)
if err != nil {
return "", fmt.Errorf("error generating webhook initiator: %w", err)
}
}
// Webhook receiver (stdhttp) pairs with the path StdHTTPServer.
// Emitted only when Generate.StdHTTPServer is on AND the spec has
// webhooks (3.1+). Uses the unified stdhttp receiver template,
// parameterized with prefix "Webhook".
var stdHTTPWebhookReceiverOut string
if opts.Generate.StdHTTPServer && len(webhookOps) > 0 {
stdHTTPWebhookReceiverOut, err = GenerateStdHTTPReceiver(t, "Webhook", webhookOps)
if err != nil {
return "", fmt.Errorf("error generating stdhttp webhook receiver: %w", err)
}
}
// Webhook receiver (chi) -- chi shares stdhttp's (w, r) handler
// signature, so the receiver shape is identical; only the template
// path differs. Emitted only when Generate.ChiServer is on.
var chiWebhookReceiverOut string
if opts.Generate.ChiServer && len(webhookOps) > 0 {
chiWebhookReceiverOut, err = GenerateChiReceiver(t, "Webhook", webhookOps)
if err != nil {
return "", fmt.Errorf("error generating chi webhook receiver: %w", err)
}
}
// Webhook receiver (gorilla/mux) -- same (w, r) signature as
// stdhttp/chi.
var gorillaWebhookReceiverOut string
if opts.Generate.GorillaServer && len(webhookOps) > 0 {
gorillaWebhookReceiverOut, err = GenerateGorillaReceiver(t, "Webhook", webhookOps)
if err != nil {
return "", fmt.Errorf("error generating gorilla webhook receiver: %w", err)
}
}
// Webhook receiver (echo v4) -- (ctx echo.Context) error signature.
var echoWebhookReceiverOut string
if opts.Generate.EchoServer && len(webhookOps) > 0 {
echoWebhookReceiverOut, err = GenerateEchoReceiver(t, "Webhook", webhookOps)
if err != nil {
return "", fmt.Errorf("error generating echo webhook receiver: %w", err)
}
}
// Webhook receiver (echo v5) -- (ctx *echo.Context) error signature.
var echo5WebhookReceiverOut string
if opts.Generate.Echo5Server && len(webhookOps) > 0 {
echo5WebhookReceiverOut, err = GenerateEcho5Receiver(t, "Webhook", webhookOps)
if err != nil {
return "", fmt.Errorf("error generating echo5 webhook receiver: %w", err)
}
}
// Webhook receiver (gin) -- (c *gin.Context) signature.
var ginWebhookReceiverOut string
if opts.Generate.GinServer && len(webhookOps) > 0 {
ginWebhookReceiverOut, err = GenerateGinReceiver(t, "Webhook", webhookOps)
if err != nil {
return "", fmt.Errorf("error generating gin webhook receiver: %w", err)
}
}
// Webhook receiver (fiber v2) -- (c *fiber.Ctx) error signature.
var fiberWebhookReceiverOut string
if opts.Generate.FiberServer && len(webhookOps) > 0 {
fiberWebhookReceiverOut, err = GenerateFiberReceiver(t, "Webhook", webhookOps)
if err != nil {
return "", fmt.Errorf("error generating fiber webhook receiver: %w", err)
}
}
// Webhook receiver (fiber v3) -- (c fiber.Ctx) error signature.
var fiberV3WebhookReceiverOut string
if opts.Generate.FiberV3Server && len(webhookOps) > 0 {
fiberV3WebhookReceiverOut, err = GenerateFiberV3Receiver(t, "Webhook", webhookOps)
if err != nil {
return "", fmt.Errorf("error generating fiber v3 webhook receiver: %w", err)
}
}
// Webhook receiver (iris) -- (ctx iris.Context) signature.
var irisWebhookReceiverOut string
if opts.Generate.IrisServer && len(webhookOps) > 0 {
irisWebhookReceiverOut, err = GenerateIrisReceiver(t, "Webhook", webhookOps)
if err != nil {
return "", fmt.Errorf("error generating iris webhook receiver: %w", err)
}
}
// Callback initiator pairs with the path Client. Emitted whenever
// Generate.Client is on and the spec declares any callbacks --
// callbacks predate 3.1 so this is not version-gated.
var callbackInitiatorOut string
if opts.Generate.Client && len(callbackOps) > 0 {
callbackInitiatorOut, err = GenerateCallbackInitiator(t, callbackOps)
if err != nil {
return "", fmt.Errorf("error generating callback initiator: %w", err)
}
}
// Callback receiver (stdhttp) pairs with the path StdHTTPServer.
// Same reasoning as the initiator: not version-gated. Uses the
// unified stdhttp receiver template with prefix "Callback".
var stdHTTPCallbackReceiverOut string
if opts.Generate.StdHTTPServer && len(callbackOps) > 0 {
stdHTTPCallbackReceiverOut, err = GenerateStdHTTPReceiver(t, "Callback", callbackOps)
if err != nil {
return "", fmt.Errorf("error generating stdhttp callback receiver: %w", err)
}
}
// Callback receiver (chi).
var chiCallbackReceiverOut string
if opts.Generate.ChiServer && len(callbackOps) > 0 {
chiCallbackReceiverOut, err = GenerateChiReceiver(t, "Callback", callbackOps)
if err != nil {
return "", fmt.Errorf("error generating chi callback receiver: %w", err)
}
}
// Callback receiver (gorilla/mux).
var gorillaCallbackReceiverOut string
if opts.Generate.GorillaServer && len(callbackOps) > 0 {
gorillaCallbackReceiverOut, err = GenerateGorillaReceiver(t, "Callback", callbackOps)
if err != nil {
return "", fmt.Errorf("error generating gorilla callback receiver: %w", err)
}
}
// Callback receiver (echo v4).
var echoCallbackReceiverOut string
if opts.Generate.EchoServer && len(callbackOps) > 0 {
echoCallbackReceiverOut, err = GenerateEchoReceiver(t, "Callback", callbackOps)
if err != nil {
return "", fmt.Errorf("error generating echo callback receiver: %w", err)
}
}
// Callback receiver (echo v5).
var echo5CallbackReceiverOut string
if opts.Generate.Echo5Server && len(callbackOps) > 0 {
echo5CallbackReceiverOut, err = GenerateEcho5Receiver(t, "Callback", callbackOps)
if err != nil {
return "", fmt.Errorf("error generating echo5 callback receiver: %w", err)
}
}
// Callback receiver (gin).
var ginCallbackReceiverOut string
if opts.Generate.GinServer && len(callbackOps) > 0 {
ginCallbackReceiverOut, err = GenerateGinReceiver(t, "Callback", callbackOps)
if err != nil {
return "", fmt.Errorf("error generating gin callback receiver: %w", err)
}
}
// Callback receiver (fiber v2).
var fiberCallbackReceiverOut string
if opts.Generate.FiberServer && len(callbackOps) > 0 {
fiberCallbackReceiverOut, err = GenerateFiberReceiver(t, "Callback", callbackOps)
if err != nil {
return "", fmt.Errorf("error generating fiber callback receiver: %w", err)
}
}
// Callback receiver (fiber v3).
var fiberV3CallbackReceiverOut string
if opts.Generate.FiberV3Server && len(callbackOps) > 0 {
fiberV3CallbackReceiverOut, err = GenerateFiberV3Receiver(t, "Callback", callbackOps)
if err != nil {
return "", fmt.Errorf("error generating fiber v3 callback receiver: %w", err)
}
}
// Callback receiver (iris).
var irisCallbackReceiverOut string
if opts.Generate.IrisServer && len(callbackOps) > 0 {
irisCallbackReceiverOut, err = GenerateIrisReceiver(t, "Callback", callbackOps)
if err != nil {
return "", fmt.Errorf("error generating iris callback receiver: %w", err)
}
}
var inlinedSpec string
if opts.Generate.EmbeddedSpec {
inlinedSpec, err = GenerateInlinedSpec(t, globalState.importMapping, spec)
if err != nil {
return "", fmt.Errorf("error generating Go handlers for Paths: %w", err)
}
}
var buf bytes.Buffer
w := bufio.NewWriter(&buf)
externalImports := append(globalState.importMapping.GoImports(), importMap(xGoTypeImports).GoImports()...)
importsOut, err := GenerateImports(
t,
externalImports,
opts.PackageName,
opts.NoVCSVersionOverride,
)
if err != nil {
return "", fmt.Errorf("error generating imports: %w", err)
}
_, err = w.WriteString(importsOut)
if err != nil {
return "", fmt.Errorf("error writing imports: %w", err)
}
_, err = w.WriteString(constantDefinitions)
if err != nil {
return "", fmt.Errorf("error writing constants: %w", err)
}
_, err = w.WriteString(serverURLsDefinitions)
if err != nil {
return "", fmt.Errorf("error writing Server URLs: %w", err)
}
_, err = w.WriteString(typeDefinitions)
if err != nil {
return "", fmt.Errorf("error writing type definitions: %w", err)
}
if opts.Generate.Client {
_, err = w.WriteString(clientOut)
if err != nil {
return "", fmt.Errorf("error writing client: %w", err)
}
_, err = w.WriteString(clientWithResponsesOut)
if err != nil {
return "", fmt.Errorf("error writing client: %w", err)
}
if webhookInitiatorOut != "" {
_, err = w.WriteString(webhookInitiatorOut)
if err != nil {
return "", fmt.Errorf("error writing webhook initiator: %w", err)
}
}
if callbackInitiatorOut != "" {
_, err = w.WriteString(callbackInitiatorOut)
if err != nil {
return "", fmt.Errorf("error writing callback initiator: %w", err)
}
}
}
if opts.Generate.IrisServer {
_, err = w.WriteString(irisServerOut)
if err != nil {
return "", fmt.Errorf("error writing server path handlers: %w", err)
}
if irisWebhookReceiverOut != "" {
_, err = w.WriteString(irisWebhookReceiverOut)
if err != nil {
return "", fmt.Errorf("error writing iris webhook receiver: %w", err)
}
}
if irisCallbackReceiverOut != "" {
_, err = w.WriteString(irisCallbackReceiverOut)
if err != nil {
return "", fmt.Errorf("error writing iris callback receiver: %w", err)
}
}
}
if opts.Generate.EchoServer {
_, err = w.WriteString(echoServerOut)
if err != nil {
return "", fmt.Errorf("error writing server path handlers: %w", err)
}
if echoWebhookReceiverOut != "" {
_, err = w.WriteString(echoWebhookReceiverOut)
if err != nil {
return "", fmt.Errorf("error writing echo webhook receiver: %w", err)
}
}
if echoCallbackReceiverOut != "" {
_, err = w.WriteString(echoCallbackReceiverOut)
if err != nil {
return "", fmt.Errorf("error writing echo callback receiver: %w", err)
}
}
}
if opts.Generate.Echo5Server {
_, err = w.WriteString(echo5ServerOut)
if err != nil {
return "", fmt.Errorf("error writing server path handlers: %w", err)
}
if echo5WebhookReceiverOut != "" {
_, err = w.WriteString(echo5WebhookReceiverOut)
if err != nil {
return "", fmt.Errorf("error writing echo5 webhook receiver: %w", err)
}
}
if echo5CallbackReceiverOut != "" {
_, err = w.WriteString(echo5CallbackReceiverOut)
if err != nil {
return "", fmt.Errorf("error writing echo5 callback receiver: %w", err)
}
}
}
if opts.Generate.ChiServer {
_, err = w.WriteString(chiServerOut)
if err != nil {
return "", fmt.Errorf("error writing server path handlers: %w", err)
}
if chiWebhookReceiverOut != "" {
_, err = w.WriteString(chiWebhookReceiverOut)
if err != nil {
return "", fmt.Errorf("error writing chi webhook receiver: %w", err)
}
}
if chiCallbackReceiverOut != "" {
_, err = w.WriteString(chiCallbackReceiverOut)
if err != nil {
return "", fmt.Errorf("error writing chi callback receiver: %w", err)
}
}
}
if opts.Generate.FiberServer {
_, err = w.WriteString(fiberServerOut)
if err != nil {
return "", fmt.Errorf("error writing server path handlers: %w", err)
}
if fiberWebhookReceiverOut != "" {
_, err = w.WriteString(fiberWebhookReceiverOut)
if err != nil {
return "", fmt.Errorf("error writing fiber webhook receiver: %w", err)
}
}
if fiberCallbackReceiverOut != "" {
_, err = w.WriteString(fiberCallbackReceiverOut)
if err != nil {
return "", fmt.Errorf("error writing fiber callback receiver: %w", err)
}
}
}
if opts.Generate.FiberV3Server {
_, err = w.WriteString(fiberV3ServerOut)
if err != nil {
return "", fmt.Errorf("error writing server path handlers: %w", err)
}
if fiberV3WebhookReceiverOut != "" {
_, err = w.WriteString(fiberV3WebhookReceiverOut)
if err != nil {
return "", fmt.Errorf("error writing fiber v3 webhook receiver: %w", err)
}
}
if fiberV3CallbackReceiverOut != "" {
_, err = w.WriteString(fiberV3CallbackReceiverOut)
if err != nil {
return "", fmt.Errorf("error writing fiber v3 callback receiver: %w", err)
}
}
}
if opts.Generate.GinServer {
_, err = w.WriteString(ginServerOut)
if err != nil {
return "", fmt.Errorf("error writing server path handlers: %w", err)
}
if ginWebhookReceiverOut != "" {
_, err = w.WriteString(ginWebhookReceiverOut)
if err != nil {
return "", fmt.Errorf("error writing gin webhook receiver: %w", err)
}
}
if ginCallbackReceiverOut != "" {
_, err = w.WriteString(ginCallbackReceiverOut)
if err != nil {
return "", fmt.Errorf("error writing gin callback receiver: %w", err)
}
}
}
if opts.Generate.GorillaServer {
_, err = w.WriteString(gorillaServerOut)
if err != nil {
return "", fmt.Errorf("error writing server path handlers: %w", err)
}
if gorillaWebhookReceiverOut != "" {
_, err = w.WriteString(gorillaWebhookReceiverOut)
if err != nil {
return "", fmt.Errorf("error writing gorilla webhook receiver: %w", err)
}
}
if gorillaCallbackReceiverOut != "" {
_, err = w.WriteString(gorillaCallbackReceiverOut)
if err != nil {
return "", fmt.Errorf("error writing gorilla callback receiver: %w", err)
}
}
}
if opts.Generate.StdHTTPServer {
_, err = w.WriteString(stdHTTPServerOut)
if err != nil {
return "", fmt.Errorf("error writing server path handlers: %w", err)
}
if stdHTTPWebhookReceiverOut != "" {
_, err = w.WriteString(stdHTTPWebhookReceiverOut)
if err != nil {
return "", fmt.Errorf("error writing stdhttp webhook receiver: %w", err)
}
}
if stdHTTPCallbackReceiverOut != "" {
_, err = w.WriteString(stdHTTPCallbackReceiverOut)
if err != nil {
return "", fmt.Errorf("error writing stdhttp callback receiver: %w", err)
}
}
}
if opts.Generate.Strict {
_, err = w.WriteString(strictServerOut)
if err != nil {
return "", fmt.Errorf("error writing server path handlers: %w", err)
}
}
if opts.Generate.EmbeddedSpec {
_, err = w.WriteString(inlinedSpec)
if err != nil {
return "", fmt.Errorf("error writing inlined spec: %w", err)
}
}
err = w.Flush()
if err != nil {
return "", fmt.Errorf("error flushing output buffer: %w", err)
}
// remove any byte-order-marks which break Go-Code
goCode := SanitizeCode(buf.String())
// The generation code produces unindented horrors. Use the Go Imports
// to make it all pretty.
if opts.OutputOptions.SkipFmt {
return goCode, nil
}