-
Notifications
You must be signed in to change notification settings - Fork 802
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
As part of #465, it'd be handy to have gorilla/mux, a commonly used HTTP server as a generated server. This is very similar to Chi, as it is also `net/http` compliant, and allows us to mostly copy-paste the code, with very minor tweaks for Gorilla-specific routing needs.
- Loading branch information
1 parent
b11a594
commit 3010f54
Showing
11 changed files
with
374 additions
and
7 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
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
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,7 @@ | ||
| // ServerInterface represents all server handlers. | ||
| type ServerInterface interface { | ||
| {{range .}}{{.SummaryAsComment }} | ||
| // ({{.Method}} {{.Path}}) | ||
| {{.OperationId}}(w http.ResponseWriter, r *http.Request{{genParamArgs .PathParams}}{{if .RequiresParamObject}}, params {{.OperationId}}Params{{end}}) | ||
| {{end}} | ||
| } |
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,251 @@ | ||
| // ServerInterfaceWrapper converts contexts to parameters. | ||
| type ServerInterfaceWrapper struct { | ||
| Handler ServerInterface | ||
| HandlerMiddlewares []MiddlewareFunc | ||
| ErrorHandlerFunc func(w http.ResponseWriter, r *http.Request, err error) | ||
| } | ||
|
|
||
| type MiddlewareFunc func(http.HandlerFunc) http.HandlerFunc | ||
|
|
||
| {{range .}}{{$opid := .OperationId}} | ||
|
|
||
| // {{$opid}} operation middleware | ||
| func (siw *ServerInterfaceWrapper) {{$opid}}(w http.ResponseWriter, r *http.Request) { | ||
| ctx := r.Context() | ||
| {{if or .RequiresParamObject (gt (len .PathParams) 0) }} | ||
| var err error | ||
| {{end}} | ||
|
|
||
| {{range .PathParams}}// ------------- Path parameter "{{.ParamName}}" ------------- | ||
| var {{$varName := .GoVariableName}}{{$varName}} {{.TypeDef}} | ||
|
|
||
| {{if .IsPassThrough}} | ||
| {{$varName}} = mux.Vars(r)["{{.ParamName}}"] | ||
| {{end}} | ||
| {{if .IsJson}} | ||
| err = json.Unmarshal([]byte(mux.Vars(r)["{{.ParamName}}"]), &{{$varName}}) | ||
| if err != nil { | ||
| siw.ErrorHandlerFunc(w, r, &UnmarshalingParamError{ParamName: "{{.ParamName}}", Err: err}) | ||
| return | ||
| } | ||
| {{end}} | ||
| {{if .IsStyled}} | ||
| err = runtime.BindStyledParameter("{{.Style}}",{{.Explode}}, "{{.ParamName}}", mux.Vars(r)["{{.ParamName}}"], &{{$varName}}) | ||
| if err != nil { | ||
| siw.ErrorHandlerFunc(w, r, &InvalidParamFormatError{ParamName: "{{.ParamName}}", Err: err}) | ||
| return | ||
| } | ||
| {{end}} | ||
|
|
||
| {{end}} | ||
|
|
||
| {{range .SecurityDefinitions}} | ||
| ctx = context.WithValue(ctx, {{.ProviderName | ucFirst}}Scopes, {{toStringArray .Scopes}}) | ||
| {{end}} | ||
|
|
||
| {{if .RequiresParamObject}} | ||
| // Parameter object where we will unmarshal all parameters from the context | ||
| var params {{.OperationId}}Params | ||
|
|
||
| {{range $paramIdx, $param := .QueryParams}}// ------------- {{if .Required}}Required{{else}}Optional{{end}} query parameter "{{.ParamName}}" ------------- | ||
| if paramValue := r.URL.Query().Get("{{.ParamName}}"); paramValue != "" { | ||
|
|
||
| {{if .IsPassThrough}} | ||
| params.{{.GoName}} = {{if not .Required}}&{{end}}paramValue | ||
| {{end}} | ||
|
|
||
| {{if .IsJson}} | ||
| var value {{.TypeDef}} | ||
| err = json.Unmarshal([]byte(paramValue), &value) | ||
| if err != nil { | ||
| siw.ErrorHandlerFunc(w, r, &UnmarshalingParamError{ParamName: "{{.ParamName}}", Err: err}) | ||
| return | ||
| } | ||
|
|
||
| params.{{.GoName}} = {{if not .Required}}&{{end}}value | ||
| {{end}} | ||
| }{{if .Required}} else { | ||
| siw.ErrorHandlerFunc(w, r, &RequiredParamError{ParamName: "{{.ParamName}}"}) | ||
| return | ||
| }{{end}} | ||
| {{if .IsStyled}} | ||
| err = runtime.BindQueryParameter("{{.Style}}", {{.Explode}}, {{.Required}}, "{{.ParamName}}", r.URL.Query(), ¶ms.{{.GoName}}) | ||
| if err != nil { | ||
| siw.ErrorHandlerFunc(w, r, &InvalidParamFormatError{ParamName: "{{.ParamName}}", Err: err}) | ||
| return | ||
| } | ||
| {{end}} | ||
| {{end}} | ||
|
|
||
| {{if .HeaderParams}} | ||
| headers := r.Header | ||
|
|
||
| {{range .HeaderParams}}// ------------- {{if .Required}}Required{{else}}Optional{{end}} header parameter "{{.ParamName}}" ------------- | ||
| if valueList, found := headers[http.CanonicalHeaderKey("{{.ParamName}}")]; found { | ||
| var {{.GoName}} {{.TypeDef}} | ||
| n := len(valueList) | ||
| if n != 1 { | ||
| siw.ErrorHandlerFunc(w, r, &TooManyValuesForParamError{ParamName: "{{.ParamName}}", Count: n}) | ||
| return | ||
| } | ||
|
|
||
| {{if .IsPassThrough}} | ||
| params.{{.GoName}} = {{if not .Required}}&{{end}}valueList[0] | ||
| {{end}} | ||
|
|
||
| {{if .IsJson}} | ||
| err = json.Unmarshal([]byte(valueList[0]), &{{.GoName}}) | ||
| if err != nil { | ||
| siw.ErrorHandlerFunc(w, r, &UnmarshalingParamError{ParamName: "{{.ParamName}}", Err: err}) | ||
| return | ||
| } | ||
| {{end}} | ||
|
|
||
| {{if .IsStyled}} | ||
| err = runtime.BindStyledParameterWithLocation("{{.Style}}",{{.Explode}}, "{{.ParamName}}", runtime.ParamLocationHeader, valueList[0], &{{.GoName}}) | ||
| if err != nil { | ||
| siw.ErrorHandlerFunc(w, r, &InvalidParamFormatError{ParamName: "{{.ParamName}}", Err: err}) | ||
| return | ||
| } | ||
| {{end}} | ||
|
|
||
| params.{{.GoName}} = {{if not .Required}}&{{end}}{{.GoName}} | ||
|
|
||
| } {{if .Required}}else { | ||
| err := fmt.Errorf("Header parameter {{.ParamName}} is required, but not found") | ||
| siw.ErrorHandlerFunc(w, r, &RequiredHeaderError{ParamName: "{{.ParamName}}", Err: err}) | ||
| return | ||
| }{{end}} | ||
|
|
||
| {{end}} | ||
| {{end}} | ||
|
|
||
| {{range .CookieParams}} | ||
| var cookie *http.Cookie | ||
|
|
||
| if cookie, err = r.Cookie("{{.ParamName}}"); err == nil { | ||
|
|
||
| {{- if .IsPassThrough}} | ||
| params.{{.GoName}} = {{if not .Required}}&{{end}}cookie.Value | ||
| {{end}} | ||
|
|
||
| {{- if .IsJson}} | ||
| var value {{.TypeDef}} | ||
| var decoded string | ||
| decoded, err := url.QueryUnescape(cookie.Value) | ||
| if err != nil { | ||
| err = fmt.Errorf("Error unescaping cookie parameter '{{.ParamName}}'") | ||
| siw.ErrorHandlerFunc(w, r, &UnescapedCookieParamError{ParamName: "{{.ParamName}}", Err: err}) | ||
| return | ||
| } | ||
|
|
||
| err = json.Unmarshal([]byte(decoded), &value) | ||
| if err != nil { | ||
| siw.ErrorHandlerFunc(w, r, &UnmarshalingParamError{ParamName: "{{.ParamName}}", Err: err}) | ||
| return | ||
| } | ||
|
|
||
| params.{{.GoName}} = {{if not .Required}}&{{end}}value | ||
| {{end}} | ||
|
|
||
| {{- if .IsStyled}} | ||
| var value {{.TypeDef}} | ||
| err = runtime.BindStyledParameter("simple",{{.Explode}}, "{{.ParamName}}", cookie.Value, &value) | ||
| if err != nil { | ||
| siw.ErrorHandlerFunc(w, r, &InvalidParamFormatError{ParamName: "{{.ParamName}}", Err: err}) | ||
| return | ||
| } | ||
| params.{{.GoName}} = {{if not .Required}}&{{end}}value | ||
| {{end}} | ||
|
|
||
| } | ||
|
|
||
| {{- if .Required}} else { | ||
| siw.ErrorHandlerFunc(w, r, &RequiredParamError{ParamName: "{{.ParamName}}"}) | ||
| return | ||
| } | ||
| {{- end}} | ||
| {{end}} | ||
| {{end}} | ||
|
|
||
| var handler = func(w http.ResponseWriter, r *http.Request) { | ||
| siw.Handler.{{.OperationId}}(w, r{{genParamNames .PathParams}}{{if .RequiresParamObject}}, params{{end}}) | ||
| } | ||
|
|
||
| for _, middleware := range siw.HandlerMiddlewares { | ||
| handler = middleware(handler) | ||
| } | ||
|
|
||
| handler(w, r.WithContext(ctx)) | ||
| } | ||
| {{end}} | ||
|
|
||
| type UnescapedCookieParamError struct { | ||
| ParamName string | ||
| Err error | ||
| } | ||
|
|
||
| func (e *UnescapedCookieParamError) Error() string { | ||
| return fmt.Sprintf("error unescaping cookie parameter '%s'", e.ParamName) | ||
| } | ||
|
|
||
| func (e *UnescapedCookieParamError) Unwrap() error { | ||
| return e.Err | ||
| } | ||
|
|
||
| type UnmarshalingParamError struct { | ||
| ParamName string | ||
| Err error | ||
| } | ||
|
|
||
| func (e *UnmarshalingParamError) Error() string { | ||
| return fmt.Sprintf("Error unmarshaling parameter %s as JSON: %s", e.ParamName, e.Err.Error()) | ||
| } | ||
|
|
||
| func (e *UnmarshalingParamError) Unwrap() error { | ||
| return e.Err | ||
| } | ||
|
|
||
| type RequiredParamError struct { | ||
| ParamName string | ||
| } | ||
|
|
||
| func (e *RequiredParamError) Error() string { | ||
| return fmt.Sprintf("Query argument %s is required, but not found", e.ParamName) | ||
| } | ||
|
|
||
| type RequiredHeaderError struct { | ||
| ParamName string | ||
| Err error | ||
| } | ||
|
|
||
| func (e *RequiredHeaderError) Error() string { | ||
| return fmt.Sprintf("Header parameter %s is required, but not found", e.ParamName) | ||
| } | ||
|
|
||
| func (e *RequiredHeaderError) Unwrap() error { | ||
| return e.Err | ||
| } | ||
|
|
||
| type InvalidParamFormatError struct { | ||
| ParamName string | ||
| Err error | ||
| } | ||
|
|
||
| func (e *InvalidParamFormatError) Error() string { | ||
| return fmt.Sprintf("Invalid format for parameter %s: %s", e.ParamName, e.Err.Error()) | ||
| } | ||
|
|
||
| func (e *InvalidParamFormatError) Unwrap() error { | ||
| return e.Err | ||
| } | ||
|
|
||
| type TooManyValuesForParamError struct { | ||
| ParamName string | ||
| Count int | ||
| } | ||
|
|
||
| func (e *TooManyValuesForParamError) Error() string { | ||
| return fmt.Sprintf("Expected one value for %s, got %d", e.ParamName, e.Count) | ||
| } | ||
|
|
Oops, something went wrong.