docs(swagger): Swagger auth

docs/docs.go

@@ -320,7 +320,19 @@ const docTemplate = `{
                 }
             }
         }
+    },
+    "securityDefinitions": {
+        "ApiKeyAuth": {
+            "type": "apiKey",
+            "name": "key",
+            "in": "query"
         }
+    },
+    "security": [
+        {
+            "ApiKeyAuth": []
+        }
+    ]
 }`
 
 // SwaggerInfo holds exported Swagger Info so clients can modify it

docs/swagger.json

@@ -311,5 +311,17 @@
                 }
             }
         }
+    },
+    "securityDefinitions": {
+        "ApiKeyAuth": {
+            "type": "apiKey",
+            "name": "key",
+            "in": "query"
         }
+    },
+    "security": [
+        {
+            "ApiKeyAuth": []
+        }
+    ]
 }

docs/swagger.yaml

@@ -211,4 +211,11 @@ paths:
       summary: Generate a contract
       tags:
       - contracts
+security:
+- ApiKeyAuth: []
+securityDefinitions:
+  ApiKeyAuth:
+    in: query
+    name: key
+    type: apiKey
 swagger: "2.0"

main.go

@@ -57,6 +57,9 @@ func loadEnv() error {
 
 // @title LfK Document Server API
 // @description This is the API documentation for the LfK Document Server - a tool for pdf generation.
+// @securityDefinitions.apiKey ApiKeyAuth
+// @in query
+// @name key
 func main() {
 
 	err := loadEnv()
@@ -76,6 +79,7 @@ func main() {
 	// Swagger documentation route
 	app.Get("/swagger/*", swagger.HandlerDefault)
 
+	// @Security ApiKeyAuth
 	v1 := app.Group("/v1")
 	v1.Use(keyauth.New(keyauth.Config{
 		KeyLookup: "query:key",