-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: openapi request and response validation middleware
This introduces a simple validation middleware which makes use of the recently added openapi3filter.Validator (see https://pkg.go.dev/github.com/getkin/kin-openapi/openapi3filter#example-Validator)
- Loading branch information
Showing
6 changed files
with
594 additions
and
19 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| package versionware | ||
|
|
||
| var DefaultValidatorConfig = defaultValidatorConfig |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,125 @@ | ||
| package versionware | ||
|
|
||
| import ( | ||
| "fmt" | ||
| "net/http" | ||
| "sort" | ||
|
|
||
| "github.com/getkin/kin-openapi/openapi3" | ||
| "github.com/getkin/kin-openapi/openapi3filter" | ||
| "github.com/getkin/kin-openapi/routers/gorillamux" | ||
|
|
||
| "github.com/snyk/vervet" | ||
| ) | ||
|
|
||
| // Validator provides versioned OpenAPI validation middleware for HTTP requests | ||
| // and responses. | ||
| type Validator struct { | ||
| versions vervet.VersionSlice | ||
| validators []*openapi3filter.Validator | ||
| errFunc VersionErrorHandler | ||
| } | ||
|
|
||
| // ValidatorConfig defines how a new Validator may be configured. | ||
| type ValidatorConfig struct { | ||
| // ServerURL overrides the server URLs in the given OpenAPI specs to match | ||
| // the URL of requests reaching the backend service. If unset, requests | ||
| // must match the servers defined in OpenAPI specs. | ||
| ServerURL string | ||
|
|
||
| // VersionError is called on any error that occurs when trying to resolve the | ||
| // API version. | ||
| VersionError VersionErrorHandler | ||
|
|
||
| // Options further configure the request and response validation. See | ||
| // https://pkg.go.dev/github.com/getkin/kin-openapi/openapi3filter#ValidatorOption | ||
| // for available options. | ||
| Options []openapi3filter.ValidatorOption | ||
| } | ||
|
|
||
| var defaultValidatorConfig = ValidatorConfig{ | ||
| VersionError: DefaultVersionError, | ||
| Options: []openapi3filter.ValidatorOption{ | ||
| openapi3filter.OnErr(func(w http.ResponseWriter, status int, code openapi3filter.ErrCode, _ error) { | ||
| statusText := http.StatusText(http.StatusInternalServerError) | ||
| switch code { | ||
| case openapi3filter.ErrCodeCannotFindRoute: | ||
| statusText = "Not Found" | ||
| case openapi3filter.ErrCodeRequestInvalid: | ||
| statusText = "Bad Request" | ||
| } | ||
| http.Error(w, statusText, status) | ||
| }), | ||
| }, | ||
| } | ||
|
|
||
| // NewValidator returns a new validation middleware, which validates versioned | ||
| // requests according to the given OpenAPI spec versions. For configuration | ||
| // defaults, a nil config may be used. | ||
| func NewValidator(config *ValidatorConfig, docs ...*openapi3.T) (*Validator, error) { | ||
| if config == nil { | ||
| config = &defaultValidatorConfig | ||
| } | ||
| if config.ServerURL != "" { | ||
| for i := range docs { | ||
| docs[i].Servers = []*openapi3.Server{{URL: config.ServerURL}} | ||
| } | ||
| } | ||
| v := &Validator{ | ||
| versions: make([]vervet.Version, len(docs)), | ||
| validators: make([]*openapi3filter.Validator, len(docs)), | ||
| errFunc: config.VersionError, | ||
| } | ||
| validatorVersions := map[string]*openapi3filter.Validator{} | ||
| for i := range docs { | ||
| if config.ServerURL != "" { | ||
| docs[i].Servers = []*openapi3.Server{{URL: config.ServerURL}} | ||
| } | ||
| versionStr, err := vervet.ExtensionString(docs[i].ExtensionProps, vervet.ExtSnykApiVersion) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
| version, err := vervet.ParseVersion(versionStr) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
| v.versions[i] = *version | ||
| router, err := gorillamux.NewRouter(docs[i]) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
| validatorVersions[version.String()] = openapi3filter.NewValidator(router, config.Options...) | ||
| } | ||
| sort.Sort(v.versions) | ||
| for i := range v.versions { | ||
| v.validators[i] = validatorVersions[v.versions[i].String()] | ||
| } | ||
| return v, nil | ||
| } | ||
|
|
||
| // Middleware returns an http.Handler which wraps the given handler with | ||
| // request and response validation according to the requested API version. | ||
| func (v *Validator) Middleware(h http.Handler) http.Handler { | ||
| handlers := make([]http.Handler, len(v.validators)) | ||
| for i := range v.versions { | ||
| handlers[i] = v.validators[i].Middleware(h) | ||
| } | ||
| return http.HandlerFunc(func(w http.ResponseWriter, req *http.Request) { | ||
| versionParam := req.URL.Query().Get("version") | ||
| if versionParam == "" { | ||
| v.errFunc(w, req, http.StatusBadRequest, fmt.Errorf("missing required query parameter 'version'")) | ||
| return | ||
| } | ||
| requested, err := vervet.ParseVersion(versionParam) | ||
| if err != nil { | ||
| v.errFunc(w, req, http.StatusBadRequest, err) | ||
| return | ||
| } | ||
| resolvedIndex, err := v.versions.ResolveIndex(*requested) | ||
| if err != nil { | ||
| v.errFunc(w, req, http.StatusNotFound, err) | ||
| return | ||
| } | ||
| handlers[resolvedIndex].ServeHTTP(w, req) | ||
| }) | ||
| } |
Oops, something went wrong.