fix: change security field type and fix tests (#76)

wI2L · Mar 31, 2022 · 8ad9884 · 8ad9884
1 parent eb08933
commit 8ad9884
Show file tree

Hide file tree

Showing 5 changed files with 49 additions and 25 deletions.
diff --git a/fizz_test.go b/fizz_test.go
@@ -258,6 +258,10 @@ type testInputModel struct {
 	QueryParam string `query:"q"`
 }
 
+type testInputModel1 struct {
+	PathParam1 string `path:"a"`
+}
+
 type testInputModel2 struct {
 	C        string      `path:"c"`
 	Message  string      `json:"message" description:"A short message"`
@@ -305,7 +309,7 @@ func TestSpecHandler(t *testing.T) {
 			WithoutSecurity(),
 			XInternal(),
 		},
-		tonic.Handler(func(c *gin.Context) (*T, error) {
+		tonic.Handler(func(c *gin.Context, in *testInputModel1) (*T, error) {
 			return &T{}, nil
 		}, 200),
 	)
@@ -350,11 +354,11 @@ func TestSpecHandler(t *testing.T) {
 	}
 	fizz.Generator().SetServers(servers)
 
-	security := openapi.SecurityRequirement{
-		"api_key": []string{},
-		"oauth2":  []string{"write:pets", "read:pets"},
+	security := []*openapi.SecurityRequirement{
+		{"api_key": []string{}},
+		{"oauth2": []string{"write:pets", "read:pets"}},
 	}
-	fizz.Generator().SetSecurityRequirement(&security)
+	fizz.Generator().SetSecurityRequirement(security)
 
 	fizz.Generator().API().Components.SecuritySchemes = map[string]*openapi.SecuritySchemeOrRef{
 		"api_key": {

diff --git a/openapi/generator.go b/openapi/generator.go
@@ -106,7 +106,7 @@ func (g *Generator) SetServers(servers []*Server) {
 
 // SetSecurityRequirement sets the security options for the
 // current specification.
-func (g *Generator) SetSecurityRequirement(security *SecurityRequirement) {
+func (g *Generator) SetSecurityRequirement(security []*SecurityRequirement) {
 	g.api.Security = security
 }
 

diff --git a/openapi/spec.go b/openapi/spec.go
@@ -5,14 +5,14 @@ import "encoding/json"
 // OpenAPI represents the root document object of
 // an OpenAPI document.
 type OpenAPI struct {
-	OpenAPI    string               `json:"openapi" yaml:"openapi"`
-	Info       *Info                `json:"info" yaml:"info"`
-	Servers    []*Server            `json:"servers,omitempty" yaml:"servers,omitempty"`
-	Paths      Paths                `json:"paths" yaml:"paths"`
-	Components *Components          `json:"components,omitempty" yaml:"components,omitempty"`
-	Tags       []*Tag               `json:"tags,omitempty" yaml:"tags,omitempty"`
-	Security   *SecurityRequirement `json:"security,omitempty" yaml:"security,omitempty"`
-	XTagGroups []*XTagGroup         `json:"x-tagGroups,omitempty" yaml:"x-tagGroups,omitempty"`
+	OpenAPI    string                 `json:"openapi" yaml:"openapi"`
+	Info       *Info                  `json:"info" yaml:"info"`
+	Servers    []*Server              `json:"servers,omitempty" yaml:"servers,omitempty"`
+	Paths      Paths                  `json:"paths" yaml:"paths"`
+	Components *Components            `json:"components,omitempty" yaml:"components,omitempty"`
+	Tags       []*Tag                 `json:"tags,omitempty" yaml:"tags,omitempty"`
+	Security   []*SecurityRequirement `json:"security,omitempty" yaml:"security,omitempty"`
+	XTagGroups []*XTagGroup           `json:"x-tagGroups,omitempty" yaml:"x-tagGroups,omitempty"`
 }
 
 // Components holds a set of reusable objects for different

diff --git a/testdata/spec.json b/testdata/spec.json
@@ -21,20 +21,34 @@
                 }
             }
         }
+    ],    
+    "security": [
+        {
+            "api_key": []
+        },
+        {
+            "oauth2": [
+                "write:pets",
+                "read:pets"
+            ]
+        }
     ],
-    "security": {
-        "api_key": [],
-        "oauth2": [
-            "write:pets",
-            "read:pets"
-        ]
-    },
     "paths": {
         "/test/{a}": {
             "get": {
                 "summary": "Test-A",
                 "description": "Test routes",
                 "operationId": "GetTest",
+                "parameters": [
+                    {
+                        "name": "a",
+                        "in": "path",
+                        "required": true,
+                        "schema": {
+                            "type": "string"
+                        }
+                    }
+                ],
                 "responses": {
                     "200": {
                         "description": "OK",

diff --git a/testdata/spec.yaml b/testdata/spec.yaml
@@ -15,16 +15,22 @@ servers:
       default: v2
       description: version of the API
 security:
-  api_key: []
-  oauth2:
-  - write:pets
-  - read:pets
+  - api_key: []
+  - oauth2:
+    - write:pets
+    - read:pets
 paths:
   /test/{a}:
     get:
       summary: Test-A
       description: Test routes
       operationId: GetTest
+      parameters:
+      - name: a
+        in: path
+        required: true
+        schema:
+          type: string
       responses:
         '200':
           description: OK