forked from oapi-codegen/oapi-codegen
-
Notifications
You must be signed in to change notification settings - Fork 2
Expand file tree
/
Copy pathcodegen.go
More file actions
1251 lines (1066 loc) · 35.8 KB
/
codegen.go
File metadata and controls
1251 lines (1066 loc) · 35.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"
"net/http"
"os"
"runtime/debug"
"sort"
"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
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
}
// 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
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())
}
return goImports
}
func constructImportMapping(importMapping map[string]string) importMap {
var (
pathToName = map[string]string{}
result = importMap{}
)
{
var packagePaths []string
for _, packageName := range importMapping {
packagePaths = append(packagePaths, packageName)
}
sort.Strings(packagePaths)
for _, packagePath := range packagePaths {
if _, ok := pathToName[packagePath]; !ok && packagePath != importMappingCurrentPackage {
pathToName[packagePath] = fmt.Sprintf("externalRef%d", len(pathToName))
}
}
}
for specPath, packagePath := range importMapping {
result[specPath] = goImport{Name: pathToName[packagePath], Path: 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) {
// This is global state
globalState.options = opts
globalState.spec = spec
globalState.importMapping = constructImportMapping(opts.ImportMapping)
filterOperationsByTag(spec, opts)
filterOperationsByOperationID(spec, opts)
if !opts.OutputOptions.SkipPrune {
pruneUnusedComponents(spec)
}
// 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)
// 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)
}
}
ops, err := OperationDefinitions(spec, opts.OutputOptions.InitialismOverrides)
if err != nil {
return "", fmt.Errorf("error creating operation definitions: %w", err)
}
xGoTypeImports, err := OperationImports(ops)
if err != nil {
return "", fmt.Errorf("error getting operation imports: %w", err)
}
var typeDefinitions, constantDefinitions string
if opts.Generate.Models {
typeDefinitions, err = GenerateTypeDefinitions(t, spec, ops, opts.OutputOptions.ExcludeSchemas)
if err != nil {
return "", fmt.Errorf("error generating type definitions: %w", err)
}
constantDefinitions, err = GenerateConstants(t, ops)
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)
}
MergeImports(xGoTypeImports, imprts)
}
var serverURLsDefinitions string
if opts.Generate.ServerURLs {
serverURLsDefinitions, err = GenerateServerURLs(t, spec)
if err != nil {
return "", fmt.Errorf("error generating Server URLs: %w", err)
}
}
var irisServerOut string
if opts.Generate.IrisServer {
irisServerOut, err = GenerateIrisServer(t, 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(t, 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(t, 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(t, 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(t, 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(t, 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, 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)
}
}
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 opts.Generate.IrisServer {
_, err = w.WriteString(irisServerOut)
if err != nil {
return "", fmt.Errorf("error writing server path handlers: %w", err)
}
}
if opts.Generate.EchoServer {
_, err = w.WriteString(echoServerOut)
if err != nil {
return "", fmt.Errorf("error writing server path handlers: %w", err)
}
}
if opts.Generate.ChiServer {
_, err = w.WriteString(chiServerOut)
if err != nil {
return "", fmt.Errorf("error writing server path handlers: %w", err)
}
}
if opts.Generate.FiberServer {
_, err = w.WriteString(fiberServerOut)
if err != nil {
return "", fmt.Errorf("error writing server path handlers: %w", err)
}
}
if opts.Generate.GinServer {
_, err = w.WriteString(ginServerOut)
if err != nil {
return "", fmt.Errorf("error writing server path handlers: %w", err)
}
}
if opts.Generate.GorillaServer {
_, err = w.WriteString(gorillaServerOut)
if err != nil {
return "", fmt.Errorf("error writing server path handlers: %w", err)
}
}
if opts.Generate.StdHTTPServer {
_, err = w.WriteString(stdHTTPServerOut)
if err != nil {
return "", fmt.Errorf("error writing server path handlers: %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
}
outBytes, err := imports.Process(opts.PackageName+".go", []byte(goCode), nil)
if err != nil {
// if we don't get a line number
errLine := -1
var scanErr scanner.ErrorList
if errors.As(err, &scanErr) && scanErr.Len() > 0 {
// for now, only return the first error's information
errLine = scanErr[0].Pos.Line
}
return "", fmt.Errorf("error formatting Go code:\n%s\nerror was: %w", addLineNumbers(goCode, errLine), err)
}
return string(outBytes), nil
}
func addLineNumbers(goCode string, lineWithError int) string {
var out []string
lines := strings.Split(goCode, "\n")
for i, line := range lines {
// lines for humans start at 1
lineNumber := i + 1
errLine := " "
if lineNumber == lineWithError {
errLine = "❗"
}
out = append(out, fmt.Sprintf("%s%5d: %s", errLine, lineNumber, line))
}
return strings.Join(out, "\n")
}
func GenerateTypeDefinitions(t *template.Template, swagger *openapi3.T, ops []OperationDefinition, excludeSchemas []string) (string, error) {
var allTypes []TypeDefinition
if swagger.Components != nil {
schemaTypes, err := GenerateTypesForSchemas(t, swagger.Components.Schemas, excludeSchemas)
if err != nil {
return "", fmt.Errorf("error generating Go types for component schemas: %w", err)
}
paramTypes, err := GenerateTypesForParameters(t, swagger.Components.Parameters)
if err != nil {
return "", fmt.Errorf("error generating Go types for component parameters: %w", err)
}
allTypes = append(schemaTypes, paramTypes...)
responseTypes, err := GenerateTypesForResponses(t, swagger.Components.Responses)
if err != nil {
return "", fmt.Errorf("error generating Go types for component responses: %w", err)
}
allTypes = append(allTypes, responseTypes...)
bodyTypes, err := GenerateTypesForRequestBodies(t, swagger.Components.RequestBodies)
if err != nil {
return "", fmt.Errorf("error generating Go types for component request bodies: %w", err)
}
allTypes = append(allTypes, bodyTypes...)
}
// Go through all operations, and add their types to allTypes, so that we can
// scan all of them for enums. Operation definitions are handled differently
// from the rest, so let's keep track of enumTypes separately, which will contain
// all types needed to be scanned for enums, which includes those within operations.
enumTypes := allTypes
for _, op := range ops {
enumTypes = append(enumTypes, op.TypeDefinitions...)
}
operationsOut, err := GenerateTypesForOperations(t, ops)
if err != nil {
return "", fmt.Errorf("error generating Go types for component request bodies: %w", err)
}
enumsOut, err := GenerateEnums(t, enumTypes)
if err != nil {
return "", fmt.Errorf("error generating code for type enums: %w", err)
}
typesOut, err := GenerateTypes(t, allTypes)
if err != nil {
return "", fmt.Errorf("error generating code for type definitions: %w", err)
}
allOfBoilerplate, err := GenerateAdditionalPropertyBoilerplate(t, allTypes)
if err != nil {
return "", fmt.Errorf("error generating allOf boilerplate: %w", err)
}
unionBoilerplate, err := GenerateUnionBoilerplate(t, allTypes)
if err != nil {
return "", fmt.Errorf("error generating union boilerplate: %w", err)
}
unionAndAdditionalBoilerplate, err := GenerateUnionAndAdditionalProopertiesBoilerplate(t, allTypes)
if err != nil {
return "", fmt.Errorf("error generating boilerplate for union types with additionalProperties: %w", err)
}
typeDefinitions := strings.Join([]string{enumsOut, typesOut, operationsOut, allOfBoilerplate, unionBoilerplate, unionAndAdditionalBoilerplate}, "")
return typeDefinitions, nil
}
// GenerateConstants generates operation ids, context keys, paths, etc. to be exported as constants
func GenerateConstants(t *template.Template, ops []OperationDefinition) (string, error) {
constants := Constants{
SecuritySchemeProviderNames: []string{},
}
providerNameMap := map[string]struct{}{}
for _, op := range ops {
for _, def := range op.SecurityDefinitions {
providerName := SanitizeGoIdentity(def.ProviderName)
providerNameMap[providerName] = struct{}{}
}
}
var providerNames []string
for providerName := range providerNameMap {
providerNames = append(providerNames, providerName)
}
sort.Strings(providerNames)
constants.SecuritySchemeProviderNames = append(constants.SecuritySchemeProviderNames, providerNames...)
return GenerateTemplates([]string{"constants.tmpl"}, t, constants)
}
// GenerateTypesForSchemas generates type definitions for any custom types defined in the
// components/schemas section of the Swagger spec.
func GenerateTypesForSchemas(t *template.Template, schemas map[string]*openapi3.SchemaRef, excludeSchemas []string) ([]TypeDefinition, error) {
excludeSchemasMap := make(map[string]bool)
for _, schema := range excludeSchemas {
excludeSchemasMap[schema] = true
}
types := make([]TypeDefinition, 0)
// We're going to define Go types for every object under components/schemas
for _, schemaName := range SortedSchemaKeys(schemas) {
if _, ok := excludeSchemasMap[schemaName]; ok {
continue
}
schemaRef := schemas[schemaName]
goSchema, err := GenerateGoSchema(schemaRef, []string{schemaName})
if err != nil {
return nil, fmt.Errorf("error converting Schema %s to Go type: %w", schemaName, err)
}
goTypeName, err := renameSchema(schemaName, schemaRef)
if err != nil {
return nil, fmt.Errorf("error making name for components/schemas/%s: %w", schemaName, err)
}
types = append(types, TypeDefinition{
JsonName: schemaName,
TypeName: goTypeName,
Schema: goSchema,
})
types = append(types, goSchema.AdditionalTypes...)
}
return types, nil
}
// GenerateTypesForParameters generates type definitions for any custom types defined in the
// components/parameters section of the Swagger spec.
func GenerateTypesForParameters(t *template.Template, params map[string]*openapi3.ParameterRef) ([]TypeDefinition, error) {
var types []TypeDefinition
for _, paramName := range SortedMapKeys(params) {
paramOrRef := params[paramName]
goType, err := paramToGoType(paramOrRef.Value, nil)
if err != nil {
return nil, fmt.Errorf("error generating Go type for schema in parameter %s: %w", paramName, err)
}
goTypeName, err := renameParameter(paramName, paramOrRef)
if err != nil {
return nil, fmt.Errorf("error making name for components/parameters/%s: %w", paramName, err)
}
typeDef := TypeDefinition{
JsonName: paramName,
Schema: goType,
TypeName: goTypeName,
}
if paramOrRef.Ref != "" {
// Generate a reference type for referenced parameters
refType, err := RefPathToGoType(paramOrRef.Ref)
if err != nil {
return nil, fmt.Errorf("error generating Go type for (%s) in parameter %s: %w", paramOrRef.Ref, paramName, err)
}
typeDef.TypeName = SchemaNameToTypeName(refType)
}
types = append(types, typeDef)
}
return types, nil
}
// GenerateTypesForResponses generates type definitions for any custom types defined in the
// components/responses section of the Swagger spec.
func GenerateTypesForResponses(t *template.Template, responses openapi3.ResponseBodies) ([]TypeDefinition, error) {
var types []TypeDefinition
for _, responseName := range SortedMapKeys(responses) {
responseOrRef := responses[responseName]
// We have to generate the response object. We're only going to
// handle media types that conform to JSON. Other responses should
// simply be specified as strings or byte arrays.
response := responseOrRef.Value
jsonCount := 0
for mediaType := range response.Content {
if util.IsMediaTypeJson(mediaType) {
jsonCount++
}
}
SortedMapKeys := SortedMapKeys(response.Content)
for _, mediaType := range SortedMapKeys {
response := response.Content[mediaType]
if !util.IsMediaTypeJson(mediaType) {
continue
}
goType, err := GenerateGoSchema(response.Schema, []string{responseName})
if err != nil {
return nil, fmt.Errorf("error generating Go type for schema in response %s: %w", responseName, err)
}
goTypeName, err := renameResponse(responseName, responseOrRef)
if err != nil {
return nil, fmt.Errorf("error making name for components/responses/%s: %w", responseName, err)
}
goType.DefinedComp = ComponentTypeResponse
typeDef := TypeDefinition{
JsonName: responseName,
Schema: goType,
TypeName: goTypeName,
}
if responseOrRef.Ref != "" {
// Generate a reference type for referenced parameters
refType, err := RefPathToGoType(responseOrRef.Ref)
if err != nil {
return nil, fmt.Errorf("error generating Go type for (%s) in parameter %s: %w", responseOrRef.Ref, responseName, err)
}
typeDef.TypeName = SchemaNameToTypeName(refType)
}
if jsonCount > 1 {
typeDef.TypeName = typeDef.TypeName + mediaTypeToCamelCase(mediaType)
}
types = append(types, typeDef)
}
}
return types, nil
}
// GenerateTypesForRequestBodies generates type definitions for any custom types defined in the
// components/requestBodies section of the Swagger spec.
func GenerateTypesForRequestBodies(t *template.Template, bodies map[string]*openapi3.RequestBodyRef) ([]TypeDefinition, error) {
var types []TypeDefinition
for _, requestBodyName := range SortedMapKeys(bodies) {
requestBodyRef := bodies[requestBodyName]
// As for responses, we will only generate Go code for JSON bodies,
// the other body formats are up to the user.
response := requestBodyRef.Value
for mediaType, body := range response.Content {
if !util.IsMediaTypeJson(mediaType) {
continue
}
goType, err := GenerateGoSchema(body.Schema, []string{requestBodyName})
if err != nil {
return nil, fmt.Errorf("error generating Go type for schema in body %s: %w", requestBodyName, err)
}
goTypeName, err := renameRequestBody(requestBodyName, requestBodyRef)
if err != nil {
return nil, fmt.Errorf("error making name for components/schemas/%s: %w", requestBodyName, err)
}
goType.DefinedComp = ComponentTypeRequestBody
typeDef := TypeDefinition{
JsonName: requestBodyName,
Schema: goType,
TypeName: goTypeName,
}
if requestBodyRef.Ref != "" {
// Generate a reference type for referenced bodies
refType, err := RefPathToGoType(requestBodyRef.Ref)
if err != nil {
return nil, fmt.Errorf("error generating Go type for (%s) in body %s: %w", requestBodyRef.Ref, requestBodyName, err)
}
typeDef.TypeName = SchemaNameToTypeName(refType)
}
types = append(types, typeDef)
}
}
return types, nil
}
// GenerateTypes passes a bunch of types to the template engine, and buffers
// its output into a string.
func GenerateTypes(t *template.Template, types []TypeDefinition) (string, error) {
m := map[string]TypeDefinition{}
var ts []TypeDefinition
if globalState.options.OutputOptions.ResolveTypeNameCollisions {
types = FixDuplicateTypeNames(types)
}
for _, typ := range types {
if prevType, found := m[typ.TypeName]; found {
// If type names collide after auto-rename, we need to see if they
// refer to the same exact type definition, in which case, we can
// de-dupe. If they don't match, we error out.
if TypeDefinitionsEquivalent(prevType, typ) {
continue
}
return "", fmt.Errorf("duplicate typename '%s' detected, can't auto-rename, "+
"please use x-go-name to specify your own name for one of them", typ.TypeName)
}
m[typ.TypeName] = typ
ts = append(ts, typ)
}
context := struct {
Types []TypeDefinition
}{
Types: ts,
}
return GenerateTemplates([]string{"typedef.tmpl"}, t, context)
}
func GenerateEnums(t *template.Template, types []TypeDefinition) (string, error) {
enums := []EnumDefinition{}
// Keep track of which enums we've generated
m := map[string]bool{}
// These are all types defined globally
for _, tp := range types {
if found := m[tp.TypeName]; found {
continue
}
m[tp.TypeName] = true
if len(tp.Schema.EnumValues) > 0 {
wrapper := ""
if tp.Schema.GoType == "string" {
wrapper = `"`
}
enums = append(enums, EnumDefinition{
Schema: tp.Schema,
TypeName: tp.TypeName,
ValueWrapper: wrapper,
PrefixTypeName: globalState.options.Compatibility.AlwaysPrefixEnumValues,
})
}
}
// Now, go through all the enums, and figure out if we have conflicts with
// any others.
for i := range enums {
// Look through all other enums not compared so far. Make sure we don't
// compare against self.
e1 := enums[i]
for j := i + 1; j < len(enums); j++ {
e2 := enums[j]
for e1key := range e1.GetValues() {
_, found := e2.GetValues()[e1key]
if found {
e1.PrefixTypeName = true
e2.PrefixTypeName = true
enums[i] = e1
enums[j] = e2
break
}
}
}
// now see if this enum conflicts with any global type names.
for _, tp := range types {
// Skip over enums, since we've handled those above.
if len(tp.Schema.EnumValues) > 0 {
continue
}
_, found := e1.Schema.EnumValues[tp.TypeName]
if found {
e1.PrefixTypeName = true
enums[i] = e1
}
}
// Another edge case is that an enum value can conflict with its own
// type name.
_, found := e1.GetValues()[e1.TypeName]
if found {
e1.PrefixTypeName = true
enums[i] = e1
}
}
// Now see if enums conflict with any non-enum typenames
return GenerateTemplates([]string{"constants.tmpl"}, t, Constants{EnumDefinitions: enums})
}
// GenerateImports generates our import statements and package definition.
func GenerateImports(t *template.Template, externalImports []string, packageName string, versionOverride *string) (string, error) {
// Read build version for incorporating into generated files
// Unit tests have ok=false, so we'll just use "unknown" for the
// version if we can't read this.
modulePath := "unknown module path"
moduleVersion := "unknown version"
if bi, ok := debug.ReadBuildInfo(); ok {
if bi.Main.Path != "" {
modulePath = bi.Main.Path
}
if bi.Main.Version != "" {
moduleVersion = bi.Main.Version
}
if versionOverride != nil {
moduleVersion = *versionOverride
}
}
context := struct {
ExternalImports []string
PackageName string
ModuleName string
Version string
AdditionalImports []AdditionalImport
}{
ExternalImports: externalImports,
PackageName: packageName,
ModuleName: modulePath,
Version: moduleVersion,
AdditionalImports: globalState.options.AdditionalImports,
}
return GenerateTemplates([]string{"imports.tmpl"}, t, context)
}
// GenerateAdditionalPropertyBoilerplate generates all the glue code which provides
// the API for interacting with additional properties and JSON-ification
func GenerateAdditionalPropertyBoilerplate(t *template.Template, typeDefs []TypeDefinition) (string, error) {
var filteredTypes []TypeDefinition
m := map[string]bool{}
for _, t := range typeDefs {
if found := m[t.TypeName]; found {
continue
}
m[t.TypeName] = true
if t.Schema.HasAdditionalProperties {
filteredTypes = append(filteredTypes, t)
}
}
context := struct {
Types []TypeDefinition
}{
Types: filteredTypes,
}
return GenerateTemplates([]string{"additional-properties.tmpl"}, t, context)
}
func GenerateUnionBoilerplate(t *template.Template, typeDefs []TypeDefinition) (string, error) {
var filteredTypes []TypeDefinition
for _, t := range typeDefs {
if len(t.Schema.UnionElements) != 0 {
filteredTypes = append(filteredTypes, t)
}
}
if len(filteredTypes) == 0 {
return "", nil
}
context := struct {
Types []TypeDefinition
}{
Types: filteredTypes,
}
return GenerateTemplates([]string{"union.tmpl"}, t, context)
}
func GenerateUnionAndAdditionalProopertiesBoilerplate(t *template.Template, typeDefs []TypeDefinition) (string, error) {
var filteredTypes []TypeDefinition
for _, t := range typeDefs {
if len(t.Schema.UnionElements) != 0 && t.Schema.HasAdditionalProperties {
filteredTypes = append(filteredTypes, t)
}
}
if len(filteredTypes) == 0 {
return "", nil
}
context := struct {
Types []TypeDefinition
}{
Types: filteredTypes,
}
return GenerateTemplates([]string{"union-and-additional-properties.tmpl"}, t, context)
}
// SanitizeCode runs sanitizers across the generated Go code to ensure the
// generated code will be able to compile.
func SanitizeCode(goCode string) string {
// remove any byte-order-marks which break Go-Code
// See: https://groups.google.com/forum/#!topic/golang-nuts/OToNIPdfkks
return strings.ReplaceAll(goCode, "\uFEFF", "")
}
// GetUserTemplateText attempts to retrieve the template text from a passed in URL or file
// path when inputData is more than one line.
// This function will attempt to load a file first, and if it fails, will try to get the
// data from the remote endpoint.
// The timeout for remote download file is 30 seconds.
func GetUserTemplateText(inputData string) (template string, err error) {
// if the input data is more than one line, assume its a template and return that data.
if strings.Contains(inputData, "\n") {
return inputData, nil
}
// load data from file
data, err := os.ReadFile(inputData)
// return data if found and loaded
if err == nil {
return string(data), nil
}
// check for non "not found" errors
if !os.IsNotExist(err) {
return "", fmt.Errorf("failed to open file %s: %w", inputData, err)
}
// attempt to get data from url with timeout