From eebaee2ce00aab1aaf94225d6ebf26a430010c66 Mon Sep 17 00:00:00 2001
From: linjieren <linjieren@kylinos.cn>
Date: Thu, 25 Jul 2024 10:07:18 +0800
Subject: [PATCH] feat: add apidocs title and description

Signed-off-by: linjieren <linjieren@kylinos.cn>
---
 src/app/server/docs/docs.go      | 14 +++++++++-----
 src/app/server/docs/swagger.json | 11 ++++++++++-
 src/app/server/docs/swagger.yaml |  8 ++++++++
 src/app/server/main.go           |  8 ++++++++
 4 files changed, 35 insertions(+), 6 deletions(-)

diff --git a/src/app/server/docs/docs.go b/src/app/server/docs/docs.go
index 9f6a7a82..44ad2878 100644
--- a/src/app/server/docs/docs.go
+++ b/src/app/server/docs/docs.go
@@ -10,6 +10,10 @@ const docTemplate = `{
         "description": "{{escape .Description}}",
         "title": "{{.Title}}",
         "contact": {},
+        "license": {
+            "name": "MulanPSL2",
+            "url": "http://license.coscl.org.cn/MulanPSL2"
+        },
         "version": "{{.Version}}"
     },
     "host": "{{.Host}}",
@@ -94,12 +98,12 @@ const docTemplate = `{
 
 // SwaggerInfo holds exported Swagger Info so clients can modify it
 var SwaggerInfo = &swag.Spec{
-	Version:          "",
-	Host:             "",
-	BasePath:         "",
+	Version:          "1.0",
+	Host:             "localhost:8888",
+	BasePath:         "/api/v1",
 	Schemes:          []string{},
-	Title:            "",
-	Description:      "",
+	Title:            "PilotGo Swagger  API",
+	Description:      "This is a pilotgo server API docs.",
 	InfoInstanceName: "swagger",
 	SwaggerTemplate:  docTemplate,
 	LeftDelim:        "{{",
diff --git a/src/app/server/docs/swagger.json b/src/app/server/docs/swagger.json
index 79b7462f..80362986 100644
--- a/src/app/server/docs/swagger.json
+++ b/src/app/server/docs/swagger.json
@@ -1,8 +1,17 @@
 {
     "swagger": "2.0",
     "info": {
-        "contact": {}
+        "description": "This is a pilotgo server API docs.",
+        "title": "PilotGo Swagger  API",
+        "contact": {},
+        "license": {
+            "name": "MulanPSL2",
+            "url": "http://license.coscl.org.cn/MulanPSL2"
+        },
+        "version": "1.0"
     },
+    "host": "localhost:8888",
+    "basePath": "/api/v1",
     "paths": {
         "/api/v1/user/login": {
             "post": {
diff --git a/src/app/server/docs/swagger.yaml b/src/app/server/docs/swagger.yaml
index 440fa2fa..7bf7fc65 100644
--- a/src/app/server/docs/swagger.yaml
+++ b/src/app/server/docs/swagger.yaml
@@ -1,3 +1,4 @@
+basePath: /api/v1
 definitions:
   user.UserInfo:
     properties:
@@ -20,8 +21,15 @@ definitions:
     required:
     - email
     type: object
+host: localhost:8888
 info:
   contact: {}
+  description: This is a pilotgo server API docs.
+  license:
+    name: MulanPSL2
+    url: http://license.coscl.org.cn/MulanPSL2
+  title: PilotGo Swagger  API
+  version: "1.0"
 paths:
   /api/v1/user/login:
     post:
diff --git a/src/app/server/main.go b/src/app/server/main.go
index 9756e0c8..8630acd6 100644
--- a/src/app/server/main.go
+++ b/src/app/server/main.go
@@ -19,6 +19,14 @@ import (
 	_ "gitee.com/openeuler/PilotGo/app/server/docs"
 )
 
+// @title          PilotGo Swagger  API
+// @version         1.0
+// @description     This is a pilotgo server API docs.
+// @license.name  MulanPSL2
+// @license.url   http://license.coscl.org.cn/MulanPSL2
+// @host      localhost:8888
+// @BasePath  /api/v1
+// SwaggerUI: http://localhost:8888/swagger/index.html
 func main() {
 	commands.Execute()
 }
-- 
Gitee