-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathopenapi.go
More file actions
922 lines (832 loc) · 31.2 KB
/
openapi.go
File metadata and controls
922 lines (832 loc) · 31.2 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
package module
import (
"bytes"
"context"
"encoding/json"
"errors"
"fmt"
"html"
"io"
"log/slog"
"math"
"net/http"
"net/url"
"os"
"regexp"
"sort"
"strconv"
"strings"
"github.com/CrisisTextLine/modular"
"gopkg.in/yaml.v3"
)
// OpenAPIValidationConfig controls which request/response parts are validated.
type OpenAPIValidationConfig struct {
Request bool `yaml:"request" json:"request"`
Response bool `yaml:"response" json:"response"`
}
// OpenAPISwaggerUIConfig controls Swagger UI hosting.
type OpenAPISwaggerUIConfig struct {
Enabled bool `yaml:"enabled" json:"enabled"`
Path string `yaml:"path" json:"path"`
}
// OpenAPIConfig holds the full configuration for an OpenAPI module.
type OpenAPIConfig struct {
SpecFile string `yaml:"spec_file" json:"spec_file"`
BasePath string `yaml:"base_path" json:"base_path"`
Validation OpenAPIValidationConfig `yaml:"validation" json:"validation"`
SwaggerUI OpenAPISwaggerUIConfig `yaml:"swagger_ui" json:"swagger_ui"`
RouterName string `yaml:"router" json:"router"` // optional: explicit router to attach to
MaxBodyBytes int64 `yaml:"max_body_bytes" json:"max_body_bytes"` // max request body size (bytes); 0 = use default
RegisterRoutes *bool `yaml:"register_routes" json:"register_routes"` // when false, skip spec-path route registration; default true
}
// defaultMaxBodyBytes is the default request body size limit (1 MiB) applied
// when Validation.Request is enabled and MaxBodyBytes is not explicitly set.
const defaultMaxBodyBytes int64 = 1 << 20 // 1 MiB
// ---- Minimal OpenAPI v3 structs (parsed from YAML/JSON) ----
// openAPISpec is a minimal representation of an OpenAPI 3.x specification.
type openAPISpec struct {
OpenAPI string `yaml:"openapi" json:"openapi"`
Info openAPIInfo `yaml:"info" json:"info"`
Paths map[string]openAPIPathItem `yaml:"paths" json:"paths"`
}
type openAPIInfo struct {
Title string `yaml:"title" json:"title"`
Version string `yaml:"version" json:"version"`
}
// openAPIPathItem maps HTTP methods to operation objects.
type openAPIPathItem map[string]*openAPIOperation
// openAPIOperation holds the metadata for a single operation.
type openAPIOperation struct {
OperationID string `yaml:"operationId" json:"operationId"`
Summary string `yaml:"summary" json:"summary"`
Parameters []openAPIParameter `yaml:"parameters" json:"parameters"`
RequestBody *openAPIRequestBody `yaml:"requestBody" json:"requestBody"`
Responses map[string]openAPIResponse `yaml:"responses" json:"responses"`
XPipeline string `yaml:"x-pipeline" json:"x-pipeline"`
}
// openAPIParameter describes a path, query, header, or cookie parameter.
type openAPIParameter struct {
Name string `yaml:"name" json:"name"`
In string `yaml:"in" json:"in"` // path | query | header | cookie
Required bool `yaml:"required" json:"required"`
Schema *openAPISchema `yaml:"schema" json:"schema"`
}
// openAPIRequestBody describes the request body for an operation.
type openAPIRequestBody struct {
Required bool `yaml:"required" json:"required"`
Content map[string]openAPIMediaType `yaml:"content" json:"content"`
}
// openAPIMediaType holds a schema for a content type entry.
type openAPIMediaType struct {
Schema *openAPISchema `yaml:"schema" json:"schema"`
}
// openAPIResponse describes a single response entry.
type openAPIResponse struct {
Description string `yaml:"description" json:"description"`
}
// openAPISchema is a minimal JSON Schema subset used for parameter/body validation.
type openAPISchema struct {
Type string `yaml:"type" json:"type"`
Required []string `yaml:"required" json:"required"`
Properties map[string]*openAPISchema `yaml:"properties" json:"properties"`
Format string `yaml:"format" json:"format"`
Minimum *float64 `yaml:"minimum" json:"minimum"`
Maximum *float64 `yaml:"maximum" json:"maximum"`
MinLength *int `yaml:"minLength" json:"minLength"`
MaxLength *int `yaml:"maxLength" json:"maxLength"`
Pattern string `yaml:"pattern" json:"pattern"`
Enum []any `yaml:"enum" json:"enum"`
}
// ---- OpenAPIModule ----
// OpenAPIModule parses an OpenAPI v3 spec and registers HTTP routes that
// validate incoming requests against the spec schemas.
type OpenAPIModule struct {
name string
cfg OpenAPIConfig
spec *openAPISpec
specBytes []byte // raw spec bytes for serving (original file content)
specJSON []byte // cached JSON-serialised spec for /openapi.json endpoint
routerName string
logger *slog.Logger
pipelineLookup PipelineLookupFn
}
// NewOpenAPIModule creates a new OpenAPIModule with the given name and config.
func NewOpenAPIModule(name string, cfg OpenAPIConfig) *OpenAPIModule {
return &OpenAPIModule{
name: name,
cfg: cfg,
routerName: cfg.RouterName,
logger: slog.Default(),
}
}
// Name returns the module name.
func (m *OpenAPIModule) Name() string { return m.name }
// Init loads and parses the spec file.
func (m *OpenAPIModule) Init(app modular.Application) error {
if app != nil {
if logger := app.Logger(); logger != nil {
if sl, ok := logger.(*slog.Logger); ok {
m.logger = sl
}
}
}
if m.cfg.SpecFile == "" {
return fmt.Errorf("openapi module %q: spec_file is required", m.name)
}
data, err := os.ReadFile(m.cfg.SpecFile) //nolint:gosec // path comes from operator config
if err != nil {
return fmt.Errorf("openapi module %q: reading spec file %q: %w", m.name, m.cfg.SpecFile, err)
}
m.specBytes = data
spec, err := parseOpenAPISpec(data)
if err != nil {
return fmt.Errorf("openapi module %q: parsing spec: %w", m.name, err)
}
m.spec = spec
m.logger.Info("OpenAPI spec loaded",
"module", m.name,
"title", spec.Info.Title,
"version", spec.Info.Version,
"paths", len(spec.Paths),
)
return nil
}
// Dependencies returns nil; routing is wired via ProvidesServices / Init wiring hooks.
func (m *OpenAPIModule) Dependencies() []string { return nil }
// Start is a no-op; routes are registered during wiring.
func (m *OpenAPIModule) Start(_ context.Context) error { return nil }
// Stop is a no-op.
func (m *OpenAPIModule) Stop(_ context.Context) error { return nil }
// ProvidesServices exposes this module as an OpenAPIModule service so wiring
// hooks can find it and register its routes on an HTTP router.
func (m *OpenAPIModule) ProvidesServices() []modular.ServiceProvider {
return []modular.ServiceProvider{
{
Name: m.name,
Description: "OpenAPI spec router module",
Instance: m,
},
}
}
// RequiresServices returns nil; router dependency is resolved via wiring hooks.
func (m *OpenAPIModule) RequiresServices() []modular.ServiceDependency { return nil }
// RouterName returns the optional explicit router module name to attach routes to.
func (m *OpenAPIModule) RouterName() string { return m.routerName }
// SetPipelineLookup sets the function used to resolve pipeline names found in
// x-pipeline operation extensions. This must be called before RegisterRoutes.
func (m *OpenAPIModule) SetPipelineLookup(fn PipelineLookupFn) {
m.pipelineLookup = fn
}
// RegisterRoutes attaches all spec paths (and optional Swagger UI / spec endpoints)
// to the given HTTPRouter.
func (m *OpenAPIModule) RegisterRoutes(router HTTPRouter) {
if m.spec == nil {
m.logger.Warn("OpenAPI spec not loaded; skipping route registration", "module", m.name)
return
}
basePath := strings.TrimRight(m.cfg.BasePath, "/")
// Register a route for each path+method in the spec, unless register_routes is explicitly false.
if m.cfg.RegisterRoutes == nil || *m.cfg.RegisterRoutes {
for specPath, pathItem := range m.spec.Paths {
for method, op := range pathItem {
httpMethod := strings.ToUpper(method)
if !isValidHTTPMethod(httpMethod) {
continue
}
routePath := basePath + openAPIPathToHTTPPath(specPath)
handler := m.buildRouteHandler(specPath, httpMethod, op)
router.AddRoute(httpMethod, routePath, handler)
m.logger.Debug("OpenAPI route registered",
"module", m.name,
"method", httpMethod,
"path", routePath,
"operationId", op.OperationID,
)
}
}
}
// Serve raw spec at /openapi.json and (when source is YAML) /openapi.yaml
if len(m.specBytes) > 0 {
// Cache the JSON representation once per registration.
if m.specJSON == nil {
specJSON, err := json.Marshal(m.spec)
if err != nil {
specJSON = m.specBytes // fallback to raw bytes
}
m.specJSON = specJSON
}
specPathJSON := basePath + "/openapi.json"
// JSON endpoint: serve re-serialised spec as JSON.
router.AddRoute(http.MethodGet, specPathJSON, &openAPISpecHandler{specJSON: m.specJSON})
// YAML endpoint: only register /openapi.yaml when the source spec is YAML.
// When the source is JSON, clients can use /openapi.json instead.
trimmed := strings.TrimSpace(string(m.specBytes))
isJSONSource := len(trimmed) > 0 && (trimmed[0] == '{' || trimmed[0] == '[')
if !isJSONSource {
specPathYAML := basePath + "/openapi.yaml"
router.AddRoute(http.MethodGet, specPathYAML, &openAPIRawSpecHandler{specBytes: m.specBytes, contentType: "application/yaml"})
m.logger.Debug("OpenAPI spec endpoint registered", "module", m.name, "paths", []string{specPathJSON, specPathYAML})
} else {
m.logger.Debug("OpenAPI spec endpoint registered", "module", m.name, "paths", []string{specPathJSON})
}
}
// Serve Swagger UI
if m.cfg.SwaggerUI.Enabled {
uiPath := m.cfg.SwaggerUI.Path
if uiPath == "" {
uiPath = "/docs"
} else if !strings.HasPrefix(uiPath, "/") {
uiPath = "/" + uiPath
}
uiRoutePath := basePath + uiPath
specURL := basePath + "/openapi.json"
uiHandler := m.buildSwaggerUIHandler(specURL)
router.AddRoute(http.MethodGet, uiRoutePath, uiHandler)
m.logger.Info("Swagger UI registered", "module", m.name, "path", uiRoutePath, "spec", specURL)
}
}
// ---- Handler builders ----
// buildRouteHandler creates an HTTPHandler that validates the request (if enabled)
// and either executes the linked pipeline (if x-pipeline is set) or returns a 501
// Not Implemented stub response.
func (m *OpenAPIModule) buildRouteHandler(specPath, method string, op *openAPIOperation) HTTPHandler {
validateReq := m.cfg.Validation.Request
h := &openAPIRouteHandler{
module: m,
specPath: specPath,
method: method,
op: op,
validateReq: validateReq,
}
if op.XPipeline != "" {
h.pipelineName = op.XPipeline
h.pipelineLookup = m.pipelineLookup
}
return h
}
// buildSwaggerUIHandler returns an inline Swagger UI page that loads the spec
// from specURL. This avoids any asset bundling — a CDN-hosted swagger-ui is used.
func (m *OpenAPIModule) buildSwaggerUIHandler(specURL string) HTTPHandler {
html := swaggerUIHTML(m.spec.Info.Title, specURL)
return &openAPISwaggerUIHandler{html: html}
}
// ---- openAPIRouteHandler ----
type openAPIRouteHandler struct {
module *OpenAPIModule
specPath string
method string
op *openAPIOperation
validateReq bool
pipelineName string
pipelineLookup PipelineLookupFn
}
func (h *openAPIRouteHandler) Handle(w http.ResponseWriter, r *http.Request) {
if h.validateReq {
if errs := h.validate(r); len(errs) > 0 {
w.Header().Set("Content-Type", "application/json")
w.WriteHeader(http.StatusBadRequest)
_ = json.NewEncoder(w).Encode(map[string]any{
"error": "request validation failed",
"errors": errs,
})
return
}
}
// If x-pipeline is configured, execute the named pipeline.
if h.pipelineName != "" {
if h.pipelineLookup == nil {
w.Header().Set("Content-Type", "application/json")
w.WriteHeader(http.StatusInternalServerError)
_ = json.NewEncoder(w).Encode(map[string]string{
"error": fmt.Sprintf("pipeline lookup not configured for pipeline %q", h.pipelineName),
})
return
}
pipeline, ok := h.pipelineLookup(h.pipelineName)
if !ok {
w.Header().Set("Content-Type", "application/json")
w.WriteHeader(http.StatusBadGateway)
_ = json.NewEncoder(w).Encode(map[string]string{
"error": fmt.Sprintf("pipeline %q not found", h.pipelineName),
})
return
}
data := openAPIExtractRequestData(r)
rw := &trackedResponseWriter{ResponseWriter: w}
ctx := context.WithValue(r.Context(), HTTPResponseWriterContextKey, rw)
ctx = context.WithValue(ctx, HTTPRequestContextKey, r)
// Use a per-request shallow copy of the pipeline to avoid concurrent
// mutations of shared pipeline state (e.g. sequence/event counters).
pipelineCopy := *pipeline
result, err := pipelineCopy.Execute(ctx, data)
if err != nil {
if !rw.written {
w.Header().Set("Content-Type", "application/json")
w.WriteHeader(http.StatusInternalServerError)
_ = json.NewEncoder(w).Encode(map[string]string{
"error": fmt.Sprintf("pipeline execution failed: %v", err),
})
}
return
}
if rw.written {
return
}
// If the pipeline set response_status in its output (without writing
// directly to the response writer), use those values to build the response.
if writePipelineContextResponse(w, result.Current) {
return
}
w.Header().Set("Content-Type", "application/json")
w.WriteHeader(http.StatusOK)
_ = json.NewEncoder(w).Encode(result.Current)
return
}
// Default stub: 501 Not Implemented
// In a full integration callers wire their own handler on top of this module.
w.Header().Set("Content-Type", "application/json")
w.WriteHeader(http.StatusNotImplemented)
_ = json.NewEncoder(w).Encode(map[string]string{
"error": "not implemented",
"operationId": h.op.OperationID,
"path": h.specPath,
"method": h.method,
})
}
// validate checks required parameters and request body against the spec.
func (h *openAPIRouteHandler) validate(r *http.Request) []string {
var errs []string
// Validate parameters
for _, p := range h.op.Parameters {
val := extractParam(r, p)
if p.Required && val == "" {
errs = append(errs, fmt.Sprintf("required parameter %q (in %s) is missing", p.Name, p.In))
continue
}
if val != "" && p.Schema != nil {
if schemaErrs := validateScalarValue(val, p.Name, "parameter", p.Schema); len(schemaErrs) > 0 {
errs = append(errs, schemaErrs...)
}
}
}
// Validate request body
if h.op.RequestBody != nil {
ct := r.Header.Get("Content-Type")
// Normalise content-type (strip params like "; charset=utf-8")
if idx := strings.Index(ct, ";"); idx >= 0 {
ct = strings.TrimSpace(ct[:idx])
}
var mediaType *openAPIMediaType
if mt, ok := h.op.RequestBody.Content[ct]; ok {
mediaType = &mt
} else if mt, ok := h.op.RequestBody.Content["application/json"]; ok && ct == "" {
// NOTE: Intentionally treat a missing Content-Type as application/json for request body
// validation. Per HTTP semantics, an absent Content-Type would normally imply
// application/octet-stream, but this engine is primarily used for JSON APIs and this
// default simplifies client usage.
mediaType = &mt
} else if ct != "" && len(h.op.RequestBody.Content) > 0 {
// Content-Type is present but not listed in the spec — reject with 400.
errs = append(errs, fmt.Sprintf("unsupported Content-Type %q; spec defines: %s",
ct, supportedContentTypes(h.op.RequestBody.Content)))
}
// Enforce a max body size to prevent DoS via arbitrarily large payloads.
// The limit is configurable via OpenAPIConfig.MaxBodyBytes; default is 1 MiB.
maxBytes := h.module.cfg.MaxBodyBytes
if maxBytes <= 0 {
maxBytes = defaultMaxBodyBytes
}
r.Body = http.MaxBytesReader(nil, r.Body, maxBytes)
// Read the body once so we can both check for presence (when required)
// and validate against the schema. Restore it afterwards for downstream handlers.
bodyBytes, readErr := io.ReadAll(r.Body)
if readErr != nil {
var maxBytesErr *http.MaxBytesError
if errors.As(readErr, &maxBytesErr) {
errs = append(errs, fmt.Sprintf("request body exceeds maximum allowed size of %d bytes", maxBytes))
} else {
h.module.logger.Error("failed to read request body for validation",
"module", h.module.name,
"path", h.specPath,
"error", readErr,
)
errs = append(errs, "failed to read request body")
}
} else {
// Always restore body for downstream handlers using the original byte slice
// to avoid a bytes→string→bytes conversion that could corrupt non-UTF-8 payloads.
r.Body = io.NopCloser(bytes.NewReader(bodyBytes))
if h.op.RequestBody.Required && len(bodyBytes) == 0 {
errs = append(errs, "request body is required but missing")
} else if mediaType != nil && mediaType.Schema != nil && len(bodyBytes) > 0 {
if ct == "application/x-www-form-urlencoded" {
formValues, parseErr := url.ParseQuery(string(bodyBytes))
if parseErr != nil {
errs = append(errs, fmt.Sprintf("request body contains invalid form data: %v", parseErr))
} else if formErrs := validateFormBody(formValues, mediaType.Schema); len(formErrs) > 0 {
errs = append(errs, formErrs...)
}
} else {
var bodyData any
if jsonErr := json.Unmarshal(bodyBytes, &bodyData); jsonErr != nil {
errs = append(errs, fmt.Sprintf("request body contains invalid JSON: %v", jsonErr))
} else if bodyErrs := validateJSONValue(bodyData, "body", mediaType.Schema); len(bodyErrs) > 0 {
errs = append(errs, bodyErrs...)
}
}
}
}
}
return errs
}
// ---- openAPISpecHandler ----
type openAPISpecHandler struct {
specJSON []byte
}
func (h *openAPISpecHandler) Handle(w http.ResponseWriter, _ *http.Request) {
w.Header().Set("Content-Type", "application/json")
w.WriteHeader(http.StatusOK)
_, _ = w.Write(h.specJSON) //nolint:gosec // G705: spec JSON is loaded from a trusted config file, not user input
}
// ---- openAPIRawSpecHandler ----
// openAPIRawSpecHandler serves the raw spec bytes with the given content-type.
// Used for the /openapi.yaml endpoint to preserve the original source format.
type openAPIRawSpecHandler struct {
specBytes []byte
contentType string
}
func (h *openAPIRawSpecHandler) Handle(w http.ResponseWriter, _ *http.Request) {
w.Header().Set("Content-Type", h.contentType)
w.WriteHeader(http.StatusOK)
_, _ = w.Write(h.specBytes) //nolint:gosec // G705: spec bytes are loaded from a trusted config file, not user input
}
// ---- openAPISwaggerUIHandler ----
type openAPISwaggerUIHandler struct {
html string
}
func (h *openAPISwaggerUIHandler) Handle(w http.ResponseWriter, _ *http.Request) {
w.Header().Set("Content-Type", "text/html; charset=utf-8")
w.WriteHeader(http.StatusOK)
_, _ = w.Write([]byte(h.html)) //nolint:gosec // G705: HTML is generated from a trusted template, not user input
}
// ---- Helpers ----
// parseOpenAPISpec parses a YAML or JSON byte slice into an openAPISpec.
func parseOpenAPISpec(data []byte) (*openAPISpec, error) {
if len(data) == 0 {
return nil, fmt.Errorf("openapi spec data is empty")
}
var spec openAPISpec
// Try YAML first (which also handles JSON since JSON is valid YAML)
if err := yaml.Unmarshal(data, &spec); err != nil {
return nil, fmt.Errorf("yaml parse: %w", err)
}
if spec.OpenAPI == "" {
// YAML parse succeeded but produced an empty OpenAPI field; try JSON directly.
if err := json.Unmarshal(data, &spec); err != nil {
return nil, fmt.Errorf("yaml parse produced empty OpenAPI field; json parse also failed: %w", err)
}
}
return &spec, nil
}
// openAPIPathToHTTPPath converts OpenAPI path templates ({param}) to Go 1.22+
// ServeMux patterns ({param}). For older mux implementations the braces are
// kept since most custom routers accept the same syntax.
func openAPIPathToHTTPPath(specPath string) string {
// OpenAPI uses {param}; Go 1.22 net/http.ServeMux uses {param} too.
// No transformation needed — return as-is.
return specPath
}
// isValidHTTPMethod returns true for standard HTTP verbs (OpenAPI supports a
// defined subset: get, put, post, delete, options, head, patch, trace).
func isValidHTTPMethod(method string) bool {
switch method {
case http.MethodGet, http.MethodPut, http.MethodPost,
http.MethodDelete, http.MethodOptions, http.MethodHead,
http.MethodPatch, "TRACE":
return true
}
return false
}
// extractParam extracts a parameter value from the request based on its location.
func extractParam(r *http.Request, p openAPIParameter) string {
switch p.In {
case "query":
return r.URL.Query().Get(p.Name)
case "header":
return r.Header.Get(p.Name)
case "path":
// Go 1.22 net/http.ServeMux populates path values via r.PathValue
return r.PathValue(p.Name)
case "cookie":
if c, err := r.Cookie(p.Name); err == nil {
return c.Value
}
}
return ""
}
// validateStringConstraints validates the string constraints (minLength, maxLength,
// pattern) for a string value. The kind parameter ("parameter" or "field") is used
// in error messages.
func validateStringConstraints(s, name, kind string, schema *openAPISchema) []string {
var errs []string
if schema.MinLength != nil && len(s) < *schema.MinLength {
errs = append(errs, fmt.Sprintf("%s %q must have minLength %d", kind, name, *schema.MinLength))
}
if schema.MaxLength != nil && len(s) > *schema.MaxLength {
errs = append(errs, fmt.Sprintf("%s %q must have maxLength %d", kind, name, *schema.MaxLength))
}
if schema.Pattern != "" {
re, err := regexp.Compile(schema.Pattern)
if err != nil {
errs = append(errs, fmt.Sprintf("%s %q has an invalid pattern %q: %v", kind, name, schema.Pattern, err))
} else if !re.MatchString(s) {
errs = append(errs, fmt.Sprintf("%s %q does not match pattern %q", kind, name, schema.Pattern))
}
}
return errs
}
// validateScalarValue validates a string value against a schema (type/format/enum checks).
// The kind parameter ("parameter" or "field") is used in error messages.
func validateScalarValue(val, name, kind string, schema *openAPISchema) []string {
var errs []string
switch schema.Type {
case "integer":
n, err := strconv.ParseInt(val, 10, 64)
if err != nil {
errs = append(errs, fmt.Sprintf("%s %q must be an integer, got %q", kind, name, val))
return errs
}
if schema.Minimum != nil && float64(n) < *schema.Minimum {
errs = append(errs, fmt.Sprintf("%s %q must be >= %v", kind, name, *schema.Minimum))
}
if schema.Maximum != nil && float64(n) > *schema.Maximum {
errs = append(errs, fmt.Sprintf("%s %q must be <= %v", kind, name, *schema.Maximum))
}
case "number":
f, err := strconv.ParseFloat(val, 64)
if err != nil {
errs = append(errs, fmt.Sprintf("%s %q must be a number, got %q", kind, name, val))
return errs
}
if schema.Minimum != nil && f < *schema.Minimum {
errs = append(errs, fmt.Sprintf("%s %q must be >= %v", kind, name, *schema.Minimum))
}
if schema.Maximum != nil && f > *schema.Maximum {
errs = append(errs, fmt.Sprintf("%s %q must be <= %v", kind, name, *schema.Maximum))
}
case "boolean":
if val != "true" && val != "false" {
errs = append(errs, fmt.Sprintf("%s %q must be 'true' or 'false', got %q", kind, name, val))
}
case "string":
errs = append(errs, validateStringConstraints(val, name, kind, schema)...)
}
// Enum validation: scalar values are always strings, so compare the
// string form of each enum value against the string value.
if len(schema.Enum) > 0 {
found := false
for _, e := range schema.Enum {
if e == nil {
continue
}
if fmt.Sprintf("%v", e) == val {
found = true
break
}
}
if !found {
errs = append(errs, fmt.Sprintf("%s %q must be one of %v", kind, name, schema.Enum))
}
}
return errs
}
// validateJSONBody validates a decoded JSON body against an object schema.
func validateJSONBody(body any, schema *openAPISchema) []string {
var errs []string
obj, ok := body.(map[string]any)
if !ok {
if schema.Type == "object" {
return []string{"request body must be a JSON object"}
}
return nil
}
// Check required fields
for _, req := range schema.Required {
if _, present := obj[req]; !present {
errs = append(errs, fmt.Sprintf("request body: required field %q is missing", req))
}
}
// Validate individual properties
for field, propSchema := range schema.Properties {
val, present := obj[field]
if !present {
continue
}
if fieldErrs := validateJSONValue(val, field, propSchema); len(fieldErrs) > 0 {
errs = append(errs, fieldErrs...)
}
}
return errs
}
// validateFormBody validates url.Values (from application/x-www-form-urlencoded) against an object schema.
// Form values are always strings, so each field is validated using validateScalarValue.
func validateFormBody(values url.Values, schema *openAPISchema) []string {
var errs []string
// Check required fields
for _, req := range schema.Required {
if _, present := values[req]; !present {
errs = append(errs, fmt.Sprintf("request body: required field %q is missing", req))
}
}
// Validate individual properties: check presence (not empty-string) so that
// present-but-empty fields are still validated against constraints like minLength/pattern/enum.
for field, propSchema := range schema.Properties {
vals, present := values[field]
if !present {
continue
}
var val string
if len(vals) > 0 {
val = vals[0]
}
if fieldErrs := validateScalarValue(val, field, "field", propSchema); len(fieldErrs) > 0 {
errs = append(errs, fieldErrs...)
}
}
return errs
}
// validateJSONValue validates a decoded JSON value against a schema.
func validateJSONValue(val any, name string, schema *openAPISchema) []string {
var errs []string
switch schema.Type {
case "string":
s, ok := val.(string)
if !ok {
return []string{fmt.Sprintf("field %q must be a string, got %T", name, val)}
}
errs = append(errs, validateStringConstraints(s, name, "field", schema)...)
case "integer":
f, ok := val.(float64)
if !ok {
return []string{fmt.Sprintf("field %q must be an integer, got %T", name, val)}
}
if f != math.Trunc(f) {
return []string{fmt.Sprintf("field %q must be an integer, got %v", name, f)}
}
if schema.Minimum != nil && f < *schema.Minimum {
errs = append(errs, fmt.Sprintf("field %q must be >= %v", name, *schema.Minimum))
}
if schema.Maximum != nil && f > *schema.Maximum {
errs = append(errs, fmt.Sprintf("field %q must be <= %v", name, *schema.Maximum))
}
case "number":
f, ok := val.(float64)
if !ok {
return []string{fmt.Sprintf("field %q must be a number, got %T", name, val)}
}
if schema.Minimum != nil && f < *schema.Minimum {
errs = append(errs, fmt.Sprintf("field %q must be >= %v", name, *schema.Minimum))
}
if schema.Maximum != nil && f > *schema.Maximum {
errs = append(errs, fmt.Sprintf("field %q must be <= %v", name, *schema.Maximum))
}
case "boolean":
if _, ok := val.(bool); !ok {
errs = append(errs, fmt.Sprintf("field %q must be a boolean, got %T", name, val))
}
case "object":
if subErrs := validateJSONBody(val, schema); len(subErrs) > 0 {
errs = append(errs, subErrs...)
}
}
// Enum validation: use type-aware comparison to prevent e.g. int 1 matching string "1".
if len(schema.Enum) > 0 {
found := false
for _, e := range schema.Enum {
if e == nil {
continue
}
// Direct equality covers string==string, bool==bool, float64==float64.
if e == val {
found = true
break
}
// Handle numeric type mismatch: YAML decodes integers as int, but JSON
// decodes all numbers as float64, so int(1) != float64(1) even though
// they represent the same value.
switch ev := e.(type) {
case int:
if fv, ok := val.(float64); ok && float64(ev) == fv {
found = true
}
case int64:
if fv, ok := val.(float64); ok && float64(ev) == fv {
found = true
}
}
if found {
break
}
}
if !found {
errs = append(errs, fmt.Sprintf("field %q must be one of %v", name, schema.Enum))
}
}
return errs
}
// swaggerUIHTML returns a minimal, self-contained Swagger UI HTML page that
// loads the spec from specURL using the official Swagger UI CDN bundle.
//
// The base URL for the Swagger UI assets can be overridden via the
// SWAGGER_UI_ASSETS_BASE_URL environment variable. If unset, it defaults to
// "https://unpkg.com/swagger-ui-dist@5". This is useful for air-gapped
// environments or when a local mirror is preferred.
func swaggerUIHTML(title, specURL string) string {
if title == "" {
title = "API Documentation"
}
baseURL := os.Getenv("SWAGGER_UI_ASSETS_BASE_URL")
if baseURL == "" {
baseURL = "https://unpkg.com/swagger-ui-dist@5"
}
baseURL = strings.TrimRight(baseURL, "/")
cssURL := baseURL + "/swagger-ui.css"
jsURL := baseURL + "/swagger-ui-bundle.js"
return `<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>` + htmlEscape(title) + `</title>
<link rel="stylesheet" href="` + htmlEscape(cssURL) + `">
</head>
<body>
<div id="swagger-ui"></div>
<script src="` + htmlEscape(jsURL) + `"></script>
<script>
SwaggerUIBundle({
url: "` + htmlEscape(specURL) + `",
dom_id: '#swagger-ui',
presets: [SwaggerUIBundle.presets.apis, SwaggerUIBundle.SwaggerUIStandalonePreset],
layout: "StandaloneLayout"
});
</script>
</body>
</html>`
}
// htmlEscape escapes a string for safe embedding in HTML attributes/text.
// It delegates to the standard library html.EscapeString for robust escaping.
func htmlEscape(s string) string {
return html.EscapeString(s)
}
// supportedContentTypes returns a sorted, comma-joined list of content types
// defined in the requestBody.content map, used in validation error messages.
func supportedContentTypes(content map[string]openAPIMediaType) string {
types := make([]string, 0, len(content))
for ct := range content {
types = append(types, ct)
}
sort.Strings(types)
return strings.Join(types, ", ")
}
// openAPIExtractRequestData builds a trigger data map from an HTTP request,
// extracting query parameters (first value per key) and, for JSON bodies,
// the decoded top-level body fields (without overwriting query param values).
// The request body is restored after reading so downstream handlers can still
// consume it.
func openAPIExtractRequestData(r *http.Request) map[string]any {
const maxBodySize = 1 << 20 // 1 MiB limit for JSON body parsing
data := make(map[string]any)
// Extract query parameters (first value per key).
for k, v := range r.URL.Query() {
if len(v) > 0 {
data[k] = v[0]
}
}
// Extract JSON body fields if Content-Type is application/json.
if r.Body != nil {
ct := r.Header.Get("Content-Type")
if idx := strings.Index(ct, ";"); idx != -1 {
ct = strings.TrimSpace(ct[:idx])
} else {
ct = strings.TrimSpace(ct)
}
if strings.EqualFold(ct, "application/json") {
bodyBytes, err := io.ReadAll(io.LimitReader(r.Body, maxBodySize))
if err == nil && len(bodyBytes) > 0 {
var bodyData map[string]any
if err := json.Unmarshal(bodyBytes, &bodyData); err == nil {
for k, v := range bodyData {
// Do not overwrite query parameters with body fields.
if _, exists := data[k]; !exists {
data[k] = v
}
}
}
// Restore r.Body so downstream handlers can still read it.
r.Body = io.NopCloser(bytes.NewReader(bodyBytes))
}
}
}
return data
}