Skip to content

Commit

Permalink
feat(parameters): add option to set query and path parameters as list
Browse files Browse the repository at this point in the history
  • Loading branch information
@Nightapes
Nightapes authored Aug 24, 2022
2 parents 52eecab + eb64cc2 commit 44b0fc1
Show file tree
Hide file tree
Showing 7 changed files with 153 additions and 46 deletions.
4 changes: 2 additions & 2 deletions .github/workflows/go.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ jobs:
build:
strategy:
matrix:
go: ["1.13","1.14","1.15", "1.16"]
go: ["1.18","1.19"]
name: Build with go version ${{ matrix.go }}
runs-on: ubuntu-latest
steps:
Expand All @@ -26,4 +26,4 @@ jobs:
- name: golangci-lint
uses: golangci/golangci-lint-action@v2
with:
version: v1.39
version: latest
22 changes: 15 additions & 7 deletions go.mod
View file
Original file line number Diff line number Diff line change
@@ -1,14 +1,22 @@
module github.com/Nightapes/go-rest

go 1.15
go 1.18

require (
github.com/getkin/kin-openapi v0.75.0
github.com/go-chi/chi/v5 v5.0.4
github.com/go-playground/validator/v10 v10.9.0
github.com/getkin/kin-openapi v0.98.0
github.com/go-chi/chi/v5 v5.0.7
github.com/go-playground/validator/v10 v10.11.0
github.com/iancoleman/orderedmap v0.2.0
golang.org/x/crypto v0.0.0-20210817164053-32db794688a5 // indirect
golang.org/x/sys v0.0.0-20210902050250-f475640dd07b // indirect
golang.org/x/text v0.3.7 // indirect
github.com/invopop/jsonschema v0.6.0
gopkg.in/yaml.v2 v2.4.0
)

require (
github.com/ghodss/yaml v1.0.0 // indirect
github.com/go-playground/locales v0.14.0 // indirect
github.com/go-playground/universal-translator v0.18.0 // indirect
github.com/leodido/go-urn v1.2.1 // indirect
golang.org/x/crypto v0.0.0-20220817201139-bc19a97f63c8 // indirect
golang.org/x/sys v0.0.0-20220823224334-20c2bfdbfe24 // indirect
golang.org/x/text v0.3.7 // indirect
)
26 changes: 26 additions & 0 deletions go.sum
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,14 @@ github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c
github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
github.com/getkin/kin-openapi v0.75.0 h1:JEt2etuOJvejeoj7VBslrpGFGKd3FNOyhFAM0uTiOOw=
github.com/getkin/kin-openapi v0.75.0/go.mod h1:7Yn5whZr5kJi6t+kShccXS8ae1APpYTW6yheSwk8Yi4=
github.com/getkin/kin-openapi v0.98.0 h1:lIACvCG9cxmFsEywz+LCoVhcZHFLUy+Nv5QSkb43eAE=
github.com/getkin/kin-openapi v0.98.0/go.mod h1:w4lRPHiyOdwGbOkLIyk+P0qCwlu7TXPCHD/64nSXzgE=
github.com/ghodss/yaml v1.0.0 h1:wQHKEahhL6wmXdzwWG11gIVCkOv05bNOh+Rxn0yngAk=
github.com/ghodss/yaml v1.0.0/go.mod h1:4dBDuWmgqj2HViK6kFavaiC9ZROes6MMH2rRYeMEF04=
github.com/go-chi/chi/v5 v5.0.4 h1:5e494iHzsYBiyXQAHHuI4tyJS9M3V84OuX3ufIIGHFo=
github.com/go-chi/chi/v5 v5.0.4/go.mod h1:DslCQbL2OYiznFReuXYUmQ2hGd1aDpCnlMNITLSKoi8=
github.com/go-chi/chi/v5 v5.0.7 h1:rDTPXLDHGATaeHvVlLcR4Qe0zftYethFucbjVQ1PxU8=
github.com/go-chi/chi/v5 v5.0.7/go.mod h1:DslCQbL2OYiznFReuXYUmQ2hGd1aDpCnlMNITLSKoi8=
github.com/go-openapi/jsonpointer v0.19.5 h1:gZr+CIYByUqjcgeLXnQu2gHYQC9o73G2XUeOFYEICuY=
github.com/go-openapi/jsonpointer v0.19.5/go.mod h1:Pl9vOtqEWErmShwVjC8pYs9cog34VGT37dQOVbmoatg=
github.com/go-openapi/swag v0.19.5 h1:lTz6Ys4CmqqCQmZPBlbQENR1/GucA2bzYTE12Pw4tFY=
Expand All @@ -20,9 +24,16 @@ github.com/go-playground/universal-translator v0.18.0 h1:82dyy6p4OuJq4/CByFNOn/j
github.com/go-playground/universal-translator v0.18.0/go.mod h1:UvRDBj+xPUEGrFYl+lu/H90nyDXpg0fqeB/AQUGNTVA=
github.com/go-playground/validator/v10 v10.9.0 h1:NgTtmN58D0m8+UuxtYmGztBJB7VnPgjj221I1QHci2A=
github.com/go-playground/validator/v10 v10.9.0/go.mod h1:74x4gJWsvQexRdW8Pn3dXSGrTK4nAUsbPlLADvpJkos=
github.com/go-playground/validator/v10 v10.11.0 h1:0W+xRM511GY47Yy3bZUbJVitCNg2BOGlCyvTqsp/xIw=
github.com/go-playground/validator/v10 v10.11.0/go.mod h1:i+3WkQ1FvaUjjxh1kSvIA4dMGDBiPU55YFDl0WbKdWU=
github.com/gorilla/mux v1.8.0/go.mod h1:DVbg23sWSpFRCP0SfiEN6jmj59UnW/n46BH5rLB71So=
github.com/iancoleman/orderedmap v0.0.0-20190318233801-ac98e3ecb4b0/go.mod h1:N0Wam8K1arqPXNWjMo21EXnBPOPp36vB07FNRdD2geA=
github.com/iancoleman/orderedmap v0.2.0 h1:sq1N/TFpYH++aViPcaKjys3bDClUEU7s5B+z6jq8pNA=
github.com/iancoleman/orderedmap v0.2.0/go.mod h1:N0Wam8K1arqPXNWjMo21EXnBPOPp36vB07FNRdD2geA=
github.com/invopop/jsonschema v0.6.0 h1:8e+xY8ZEn8gDHUYylSlLHy22P+SLeIRIHv3nM3hCbmY=
github.com/invopop/jsonschema v0.6.0/go.mod h1:O9uiLokuu0+MGFlyiaqtWxwqJm41/+8Nj0lD7A36YH0=
github.com/invopop/yaml v0.1.0 h1:YW3WGUoJEXYfzWBjn00zIlrw7brGVD0fUKRYDPAPhrc=
github.com/invopop/yaml v0.1.0/go.mod h1:2XuRLgs/ouIrW3XNzuNj7J3Nvu/Dig5MXvbCEdiBN3Q=
github.com/kr/pretty v0.1.0 h1:L/CwN0zerZDmRFUapSPitk6f+Q3+0za1rQkzVuMiMFI=
github.com/kr/pretty v0.1.0/go.mod h1:dAy3ld7l9f0ibDNOQOHHMYYIIbhfbHSm3C4ZsoJORNo=
github.com/kr/pretty v0.2.1/go.mod h1:ipq/a2n7PKx3OHsz4KJII5eveXtPO4qwEXGdVfWzfnI=
Expand All @@ -46,6 +57,7 @@ github.com/rogpeppe/go-internal v1.8.0 h1:FCbCCtXNOY3UtUuHUYaghJg4y7Fd14rXifAYUA
github.com/rogpeppe/go-internal v1.8.0/go.mod h1:WmiCO8CzOY8rg0OYDC4/i/2WRWAB6poM+XZ2dLUbcbE=
github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
github.com/stretchr/testify v1.3.0/go.mod h1:M5WIy9Dh21IEIfnGCwXGc5bZfKNJtfHm1UVUgZn+9EI=
github.com/stretchr/testify v1.3.1-0.20190311161405-34c6fa2dc709/go.mod h1:M5WIy9Dh21IEIfnGCwXGc5bZfKNJtfHm1UVUgZn+9EI=
github.com/stretchr/testify v1.5.1 h1:nOGnQDM7FYENwehXlg/kFVnos3rEvtKTjRvOWSzb6H4=
github.com/stretchr/testify v1.5.1/go.mod h1:5W2xD1RspED5o8YsWQXVCued0rvSQ+mT+I5cxcmMvtA=
github.com/stretchr/testify v1.6.1/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
Expand All @@ -54,12 +66,23 @@ github.com/stretchr/testify v1.7.0/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/
golang.org/x/crypto v0.0.0-20210711020723-a769d52b0f97/go.mod h1:GvvjBRRGRdwPK5ydBHafDWAxML/pGHZbMvKqRZ5+Abc=
golang.org/x/crypto v0.0.0-20210817164053-32db794688a5 h1:HWj/xjIHfjYU5nVXpTM0s39J9CbLn7Cc5a7IC5rwsMQ=
golang.org/x/crypto v0.0.0-20210817164053-32db794688a5/go.mod h1:GvvjBRRGRdwPK5ydBHafDWAxML/pGHZbMvKqRZ5+Abc=
golang.org/x/crypto v0.0.0-20211215153901-e495a2d5b3d3/go.mod h1:IxCIyHEi3zRg3s0A5j5BB6A9Jmi73HwBIUl50j+osU4=
golang.org/x/crypto v0.0.0-20220722155217-630584e8d5aa h1:zuSxTR4o9y82ebqCUJYNGJbGPo6sKVl54f/TVDObg1c=
golang.org/x/crypto v0.0.0-20220722155217-630584e8d5aa/go.mod h1:IxCIyHEi3zRg3s0A5j5BB6A9Jmi73HwBIUl50j+osU4=
golang.org/x/crypto v0.0.0-20220817201139-bc19a97f63c8 h1:GIAS/yBem/gq2MUqgNIzUHW7cJMmx3TGZOrnyYaNQ6c=
golang.org/x/crypto v0.0.0-20220817201139-bc19a97f63c8/go.mod h1:IxCIyHEi3zRg3s0A5j5BB6A9Jmi73HwBIUl50j+osU4=
golang.org/x/net v0.0.0-20210226172049-e18ecbb05110/go.mod h1:m0MpNAwzfU5UDzcl9v0D8zg8gWTRqZa9RBIspLL5mdg=
golang.org/x/net v0.0.0-20211112202133-69e39bad7dc2/go.mod h1:9nx3DQGgdP8bBQD5qxJ1jj9UTztislL4KSBs9R2vV5Y=
golang.org/x/sys v0.0.0-20201119102817-f84b799fce68/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
golang.org/x/sys v0.0.0-20210423082822-04245dca01da/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
golang.org/x/sys v0.0.0-20210615035016-665e8c7367d1/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
golang.org/x/sys v0.0.0-20210806184541-e5e7981a1069/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
golang.org/x/sys v0.0.0-20210902050250-f475640dd07b h1:S7hKs0Flbq0bbc9xgYt4stIEG1zNDFqyrPwAX2Wj/sE=
golang.org/x/sys v0.0.0-20210902050250-f475640dd07b/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
golang.org/x/sys v0.0.0-20220804214406-8e32c043e418 h1:9vYwv7OjYaky/tlAeD7C4oC9EsPTlaFl1H2jS++V+ME=
golang.org/x/sys v0.0.0-20220804214406-8e32c043e418/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
golang.org/x/sys v0.0.0-20220823224334-20c2bfdbfe24 h1:TyKJRhyo17yWxOMCTHKWrc5rddHORMlnZ/j57umaUd8=
golang.org/x/sys v0.0.0-20220823224334-20c2bfdbfe24/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
golang.org/x/term v0.0.0-20201126162022-7de9c90e9dd1/go.mod h1:bj7SfCRtBDWHUb9snDiAeCFNEtKQo2Wmx5Cou7ajbmo=
golang.org/x/text v0.3.3/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ=
golang.org/x/text v0.3.6/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ=
Expand All @@ -81,3 +104,6 @@ gopkg.in/yaml.v2 v2.4.0/go.mod h1:RDklbk79AGWmwhnvt/jBztapEOGDOx6ZbXqjP6csGnQ=
gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
gopkg.in/yaml.v3 v3.0.0-20210107192922-496545a6307b h1:h8qDotaEPuJATrMmW04NCwg7v22aHH28wwpauUhK9Oo=
gopkg.in/yaml.v3 v3.0.0-20210107192922-496545a6307b/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
gopkg.in/yaml.v3 v3.0.0/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=
gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
7 changes: 3 additions & 4 deletions pkg/jsonschema/reflect.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -493,7 +493,6 @@ func (t *Type) stringKeywords(tags []string) {
switch val {
case "date-time", "email", "hostname", "ipv4", "ipv6", "uri":
t.Format = val
break
}
case "default":
t.Default = val
Expand Down Expand Up @@ -605,11 +604,11 @@ func (t *Type) setExtra(key, val string) {
t.Extras = map[string]interface{}{}
}
if existingVal, ok := t.Extras[key]; ok {
switch existingVal.(type) {
switch existingVal := existingVal.(type) {
case string:
t.Extras[key] = []string{existingVal.(string), val}
t.Extras[key] = []string{existingVal, val}
case []string:
t.Extras[key] = append(existingVal.([]string), val)
t.Extras[key] = append(existingVal, val)
case int:
t.Extras[key], _ = strconv.Atoi(val)
}
Expand Down
76 changes: 45 additions & 31 deletions pkg/openapi/openapi.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,9 @@ type Parameter struct {
Name string
Required bool
Type TYPE
IsArray bool
Style Style
Explode bool
}

type PathDesc interface {
Expand Down Expand Up @@ -58,34 +61,9 @@ func NewOpenAPI() *API {
handlers: map[string]map[string]HandlerConfig{},
jsonschemaRefl: &jsonschema.Reflector{
TypeMapper: func(r reflect.Type) *jsonschema.Type {
modelType := reflect.TypeOf((*Enum)(nil)).Elem()

if r.Implements(modelType) {
enumPointer := reflect.New(r)
enumValue := enumPointer.Elem()
enumInterface := enumValue.Interface()
enumObject := enumInterface.(Enum)
if len(enumObject.GetValues()) == 0 {
log.Printf("Could not set enum values, no values found in type %s", r.Kind().String())
return nil
}

definition := &jsonschema.Type{
Enum: enumObject.GetValues(),
Type: reflect.TypeOf(enumObject.GetValues()[0]).Kind().String(),
}

return &jsonschema.Type{

Ref: "#/definitions/" + r.Name(),
Definitions: map[string]*jsonschema.Type{
r.Name(): definition,
},
}
}

return nil
return enumMapper(r)
}},

OpenAPI: OpenAPI{
Tags: []*Tag{},
OpenAPI: "3.0.0",
Expand All @@ -97,6 +75,35 @@ func NewOpenAPI() *API {
}}
}

func enumMapper(r reflect.Type) *jsonschema.Type {
modelType := reflect.TypeOf((*Enum)(nil)).Elem()

if r.Implements(modelType) {
enumPointer := reflect.New(r)
enumValue := enumPointer.Elem()
enumInterface := enumValue.Interface()
enumObject := enumInterface.(Enum)
if len(enumObject.GetValues()) == 0 {
log.Printf("Could not set enum values, no values found in type %s", r.Kind().String())
return nil
}

definition := &jsonschema.Type{
Enum: enumObject.GetValues(),
Type: reflect.TypeOf(enumObject.GetValues()[0]).Kind().String(),
}

return &jsonschema.Type{

Ref: "#/definitions/" + r.Name(),
Definitions: map[string]*jsonschema.Type{
r.Name(): definition,
},
}
}
return nil
}

func (a *API) AddExternalDocs(url, externalDescription string) {
a.ExternalDocs = &ExternalDocs{
Description: externalDescription,
Expand Down Expand Up @@ -203,7 +210,7 @@ func (a *API) toPath(desc PathDesc, pathBuilder *PathBuilder) (*Operation, *Hand
In: "path",
Deprecated: false,
Required: parameter.Required,
Schema: parameter.Type.toSchema(),
Schema: parameter.Type.toSchema(parameter.IsArray),
})
}

Expand All @@ -214,7 +221,7 @@ func (a *API) toPath(desc PathDesc, pathBuilder *PathBuilder) (*Operation, *Hand
In: "query",
Deprecated: false,
Required: parameter.Required,
Schema: parameter.Type.toSchema(),
Schema: parameter.Type.toSchema(parameter.IsArray),
})
}

Expand All @@ -225,7 +232,7 @@ func (a *API) toPath(desc PathDesc, pathBuilder *PathBuilder) (*Operation, *Hand
In: "header",
Deprecated: false,
Required: parameter.Required,
Schema: parameter.Type.toSchema(),
Schema: parameter.Type.toSchema(parameter.IsArray),
})
}

Expand Down Expand Up @@ -254,7 +261,10 @@ func (a *API) toPath(desc PathDesc, pathBuilder *PathBuilder) (*Operation, *Hand
a.handleEnumInProperties(t)
a.handleEnumInArrays(t)
a.OpenAPI.Components.Schemas[s] = t
t.Definitions = nil
t.Version = ""
}

ops.RequestBody = &RequestBody{
Required: true,
Content: map[string]*MediaType{
Expand Down Expand Up @@ -325,6 +335,9 @@ func (a *API) handleEnumInArrays(t *jsonschema.Type) {
}

func (a *API) handleEnumInProperties(t *jsonschema.Type) {
if t.Properties == nil {
return
}
for _, propKey := range t.Properties.Keys() {
prop, _ := t.Properties.Get(propKey)
parsed, _ := prop.(*jsonschema.Type)
Expand Down Expand Up @@ -488,7 +501,8 @@ func (a *API) DefaultResponse(response *MethodResponse) {

func (a *API) patchOpenApi(openapi []byte) []byte {
// Replace json definitions with open api schemas
patch := strings.ReplaceAll(string(openapi), "#/definitions", "#/components/schemas")
patch := strings.ReplaceAll(string(openapi), "#/$defs", "#/components/schemas")
patch = strings.ReplaceAll(patch, "#/definitions", "#/components/schemas")
// Remove unneeded json draft version
patch = strings.ReplaceAll(patch, `"$schema": "http://json-schema.org/draft-04/schema#",`, "")
return []byte(patch)
Expand Down
39 changes: 39 additions & 0 deletions pkg/openapi/pathBuilder.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,11 @@ import (
"strings"
)

type ParameterListOption struct {
Explode bool
Style Style
}

type PathBuilder struct {
path string
parameters []Parameter
Expand Down Expand Up @@ -38,6 +43,24 @@ func (p *PathBuilder) AddParameter(name string, t TYPE, description string) *Pat
return p
}

func (p *PathBuilder) AddParameterList(name string, t TYPE, description string, option *ParameterListOption) *PathBuilder {
p.Add(fmt.Sprintf("{%s}", name))
parameter := Parameter{
Name: name,
Description: description,
Type: t,
IsArray: true,
Required: true,
}
if option != nil {
parameter.Style = option.Style
parameter.Explode = option.Explode
}
p.parameters = append(p.parameters, parameter)

return p
}

func (p *PathBuilder) WithQueryParameter(name string, t TYPE, description string, required bool) *PathBuilder {
p.queryParameters = append(p.queryParameters, Parameter{
Name: name,
Expand All @@ -47,3 +70,19 @@ func (p *PathBuilder) WithQueryParameter(name string, t TYPE, description string
})
return p
}

func (p *PathBuilder) WithQueryParameterList(name string, t TYPE, description string, required bool, option *ParameterListOption) *PathBuilder {
parameter := Parameter{
Name: name,
Description: description,
Type: t,
Required: required,
IsArray: true,
}
if option != nil {
parameter.Style = option.Style
parameter.Explode = option.Explode
}
p.queryParameters = append(p.queryParameters, parameter)
return p
}
25 changes: 23 additions & 2 deletions pkg/openapi/simpleTypes.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,18 @@ type Enum interface {
GetValues() []interface{}
}

type Style string

const (
StyleSimple Style = "simple"
StyleLabel Style = "label"
StyleMatrix Style = "matrix"
StyleForm Style = "form"
SpaceDelimited Style = "spaceDelimited"
StylePipeDelimited Style = "pipeDelimited"
StyleDeepObject Style = "deepObject"
)

type DataType struct {
Type string
Format string
Expand Down Expand Up @@ -78,17 +90,26 @@ type Schema struct {
Type string `json:"type,omitempty" yaml:"type,omitempty"`
Format string `json:"format,omitempty" yaml:"format,omitempty"`
Enum []string `json:"enum,omitempty" yaml:"enum,omitempty"`
Items *Schema `json:"items,omitempty" yaml:"items,omitempty"`
}

func (e *TYPE) toSchema() *SchemaRef {
func (e *TYPE) toSchema(isArray bool) *SchemaRef {

schema := &Schema{
Type: e.Type,
Format: e.Format,
}
if e.Enum != nil {
schema.Enum = *e.Enum
}

if !isArray {
return &SchemaRef{
Value: schema,
}
}

return &SchemaRef{
Value: schema,
Value: &Schema{Type: "array", Items: schema},
}
}

0 comments on commit 44b0fc1

Please sign in to comment.