Add API key check endpoint and update Swagger documentation

Author: Eric-Philippe

controllers/apikey.go

@@ -0,0 +1,27 @@
+package controllers
+
+import (
+	"net/http"
+
+	"github.com/algohive/beeapi/services"
+	"github.com/gin-gonic/gin"
+)
+
+// CheckApiKey godoc
+// @Summary Check API key
+// @Description Returns the current API key
+// @Tags API Key
+// @Produce json
+// @Success 200 {object} map[string]string
+// CheckApiKey handles the API key check
+// @Router /apikey [get]
+// @Security Bearer
+func CheckApiKey(c * gin.Context) {
+	apiKeyManager, err := services.NewAPIKeyManager(".")
+	if err != nil {
+		c.JSON(http.StatusInternalServerError, gin.H{"error": "Failed to initialize API key manager"})
+		return
+	}
+
+	c.JSON(http.StatusOK, gin.H{"api_key": apiKeyManager.GetAPIKey()})
+}

docs/docs.go

@@ -22,6 +22,34 @@ const docTemplate = `{
     "host": "{{.Host}}",
     "basePath": "{{.BasePath}}",
     "paths": {
+        "/apikey": {
+            "get": {
+                "security": [
+                    {
+                        "Bearer": []
+                    }
+                ],
+                "description": "Returns the current API key",
+                "produces": [
+                    "application/json"
+                ],
+                "tags": [
+                    "API Key"
+                ],
+                "summary": "Check API key",
+                "responses": {
+                    "200": {
+                        "description": "OK",
+                        "schema": {
+                            "type": "object",
+                            "additionalProperties": {
+                                "type": "string"
+                            }
+                        }
+                    }
+                }
+            }
+        },
         "/name": {
             "get": {
                 "description": "Returns the name of the server",
@@ -647,7 +675,7 @@ const docTemplate = `{
         "Bearer": {
             "type": "apiKey",
             "name": "Authorization",
-            "in": "header"
+            "in": "Bearer"
         }
     }
 }`

docs/swagger.json

@@ -16,6 +16,34 @@
     "host": "localhost:5000",
     "basePath": "/",
     "paths": {
+        "/apikey": {
+            "get": {
+                "security": [
+                    {
+                        "Bearer": []
+                    }
+                ],
+                "description": "Returns the current API key",
+                "produces": [
+                    "application/json"
+                ],
+                "tags": [
+                    "API Key"
+                ],
+                "summary": "Check API key",
+                "responses": {
+                    "200": {
+                        "description": "OK",
+                        "schema": {
+                            "type": "object",
+                            "additionalProperties": {
+                                "type": "string"
+                            }
+                        }
+                    }
+                }
+            }
+        },
         "/name": {
             "get": {
                 "description": "Returns the name of the server",
@@ -641,7 +669,7 @@
         "Bearer": {
             "type": "apiKey",
             "name": "Authorization",
-            "in": "header"
+            "in": "Bearer"
         }
     }
 }

docs/swagger.yaml

@@ -50,6 +50,23 @@ info:
   title: BeeAPI Go
   version: "1.0"
 paths:
+  /apikey:
+    get:
+      description: Returns the current API key
+      produces:
+      - application/json
+      responses:
+        "200":
+          description: OK
+          schema:
+            additionalProperties:
+              type: string
+            type: object
+      security:
+      - Bearer: []
+      summary: Check API key
+      tags:
+      - API Key
   /name:
     get:
       description: Returns the name of the server
@@ -417,7 +434,7 @@ paths:
       - Themes
 securityDefinitions:
   Bearer:
-    in: header
+    in: Bearer
     name: Authorization
     type: apiKey
 swagger: "2.0"

main.go

@@ -31,7 +31,7 @@ import (
 // @host localhost:5000
 // @BasePath /
 // @securityDefinitions.apikey Bearer
-// @in header
+// @in Bearer
 // @name Authorization
 func main() {
 	// Load environment variables from .env file if it exists
@@ -87,6 +87,9 @@ func main() {
 	protected := router.Group("")
 	protected.Use(middlewares.RequireAPIKey(apiKeyManager))
 	{
+		// Check API key
+		protected.GET("/apikey", controllers.CheckApiKey)
+
 		// Theme management
 		protected.POST("/theme", themeController.CreateTheme)
 		protected.DELETE("/theme", themeController.DeleteTheme)