Browse Source

docs: Update swagger docs

lejianwen 7 months ago
parent
commit
c554ff4a31

+ 4 - 1
docs/admin/admin_docs.go

@@ -1,4 +1,4 @@
1
-// Package admin Content generated by swaggo/swag. DO NOT EDIT
1
+// Package admin Code generated by swaggo/swag. DO NOT EDIT
2
 package admin
2
 package admin
3
 
3
 
4
 import "github.com/swaggo/swag"
4
 import "github.com/swaggo/swag"
@@ -5828,6 +5828,9 @@ const docTemplateadmin = `{
5828
                 "captcha": {
5828
                 "captcha": {
5829
                     "type": "string"
5829
                     "type": "string"
5830
                 },
5830
                 },
5831
+                "captcha_id": {
5832
+                    "type": "string"
5833
+                },
5831
                 "password": {
5834
                 "password": {
5832
                     "type": "string"
5835
                     "type": "string"
5833
                 },
5836
                 },

+ 3 - 0
docs/admin/admin_swagger.json

@@ -5821,6 +5821,9 @@
5821
                 "captcha": {
5821
                 "captcha": {
5822
                     "type": "string"
5822
                     "type": "string"
5823
                 },
5823
                 },
5824
+                "captcha_id": {
5825
+                    "type": "string"
5826
+                },
5824
                 "password": {
5827
                 "password": {
5825
                     "type": "string"
5828
                     "type": "string"
5826
                 },
5829
                 },

+ 2 - 0
docs/admin/admin_swagger.yaml

@@ -297,6 +297,8 @@ definitions:
297
     properties:
297
     properties:
298
       captcha:
298
       captcha:
299
         type: string
299
         type: string
300
+      captcha_id:
301
+        type: string
300
       password:
302
       password:
301
         type: string
303
         type: string
302
       platform:
304
       platform:

+ 31 - 2
docs/api/api_docs.go

@@ -1,4 +1,4 @@
1
-// Package api Content generated by swaggo/swag. DO NOT EDIT
1
+// Package api Code generated by swaggo/swag. DO NOT EDIT
2
 package api
2
 package api
3
 
3
 
4
 import "github.com/swaggo/swag"
4
 import "github.com/swaggo/swag"
@@ -1208,7 +1208,7 @@ const docTemplateapi = `{
1208
                     "application/json"
1208
                     "application/json"
1209
                 ],
1209
                 ],
1210
                 "tags": [
1210
                 "tags": [
1211
-                    "地址"
1211
+                    "System"
1212
                 ],
1212
                 ],
1213
                 "summary": "提交系统信息",
1213
                 "summary": "提交系统信息",
1214
                 "parameters": [
1214
                 "parameters": [
@@ -1238,6 +1238,35 @@ const docTemplateapi = `{
1238
                 }
1238
                 }
1239
             }
1239
             }
1240
         },
1240
         },
1241
+        "/sysinfo_ver": {
1242
+            "post": {
1243
+                "description": "获取系统版本信息",
1244
+                "consumes": [
1245
+                    "application/json"
1246
+                ],
1247
+                "produces": [
1248
+                    "application/json"
1249
+                ],
1250
+                "tags": [
1251
+                    "System"
1252
+                ],
1253
+                "summary": "获取系统版本信息",
1254
+                "responses": {
1255
+                    "200": {
1256
+                        "description": "OK",
1257
+                        "schema": {
1258
+                            "type": "string"
1259
+                        }
1260
+                    },
1261
+                    "500": {
1262
+                        "description": "Internal Server Error",
1263
+                        "schema": {
1264
+                            "$ref": "#/definitions/response.ErrorResponse"
1265
+                        }
1266
+                    }
1267
+                }
1268
+            }
1269
+        },
1241
         "/users": {
1270
         "/users": {
1242
             "get": {
1271
             "get": {
1243
                 "security": [
1272
                 "security": [

+ 30 - 1
docs/api/api_swagger.json

@@ -1201,7 +1201,7 @@
1201
                     "application/json"
1201
                     "application/json"
1202
                 ],
1202
                 ],
1203
                 "tags": [
1203
                 "tags": [
1204
-                    "地址"
1204
+                    "System"
1205
                 ],
1205
                 ],
1206
                 "summary": "提交系统信息",
1206
                 "summary": "提交系统信息",
1207
                 "parameters": [
1207
                 "parameters": [
@@ -1231,6 +1231,35 @@
1231
                 }
1231
                 }
1232
             }
1232
             }
1233
         },
1233
         },
1234
+        "/sysinfo_ver": {
1235
+            "post": {
1236
+                "description": "获取系统版本信息",
1237
+                "consumes": [
1238
+                    "application/json"
1239
+                ],
1240
+                "produces": [
1241
+                    "application/json"
1242
+                ],
1243
+                "tags": [
1244
+                    "System"
1245
+                ],
1246
+                "summary": "获取系统版本信息",
1247
+                "responses": {
1248
+                    "200": {
1249
+                        "description": "OK",
1250
+                        "schema": {
1251
+                            "type": "string"
1252
+                        }
1253
+                    },
1254
+                    "500": {
1255
+                        "description": "Internal Server Error",
1256
+                        "schema": {
1257
+                            "$ref": "#/definitions/response.ErrorResponse"
1258
+                        }
1259
+                    }
1260
+                }
1261
+            }
1262
+        },
1234
         "/users": {
1263
         "/users": {
1235
             "get": {
1264
             "get": {
1236
                 "security": [
1265
                 "security": [

+ 20 - 1
docs/api/api_swagger.yaml

@@ -973,7 +973,26 @@ paths:
973
             $ref: '#/definitions/response.ErrorResponse'
973
             $ref: '#/definitions/response.ErrorResponse'
974
       summary: 提交系统信息
974
       summary: 提交系统信息
975
       tags:
975
       tags:
976
-      - 地址
976
+      - System
977
+  /sysinfo_ver:
978
+    post:
979
+      consumes:
980
+      - application/json
981
+      description: 获取系统版本信息
982
+      produces:
983
+      - application/json
984
+      responses:
985
+        "200":
986
+          description: OK
987
+          schema:
988
+            type: string
989
+        "500":
990
+          description: Internal Server Error
991
+          schema:
992
+            $ref: '#/definitions/response.ErrorResponse'
993
+      summary: 获取系统版本信息
994
+      tags:
995
+      - System
977
   /users:
996
   /users:
978
     get:
997
     get:
979
       consumes:
998
       consumes:

+ 10 - 1
http/controller/api/peer.go

@@ -14,7 +14,7 @@ type Peer struct {
14
 }
14
 }
15
 
15
 
16
 // SysInfo
16
 // SysInfo
17
-// @Tags 地址
17
+// @Tags System
18
 // @Summary 提交系统信息
18
 // @Summary 提交系统信息
19
 // @Description 提交系统信息
19
 // @Description 提交系统信息
20
 // @Accept  json
20
 // @Accept  json
@@ -58,6 +58,15 @@ func (p *Peer) SysInfo(c *gin.Context) {
58
 	c.String(http.StatusOK, "SYSINFO_UPDATED")
58
 	c.String(http.StatusOK, "SYSINFO_UPDATED")
59
 }
59
 }
60
 
60
 
61
+// SysInfoVer
62
+// @Tags System
63
+// @Summary 获取系统版本信息
64
+// @Description 获取系统版本信息
65
+// @Accept  json
66
+// @Produce  json
67
+// @Success 200 {string} string ""
68
+// @Failure 500 {object} response.ErrorResponse
69
+// @Router /sysinfo_ver [post]
61
 func (p *Peer) SysInfoVer(c *gin.Context) {
70
 func (p *Peer) SysInfoVer(c *gin.Context) {
62
 	//读取resources/version文件
71
 	//读取resources/version文件
63
 	v := service.AllService.AppService.GetAppVersion()
72
 	v := service.AllService.AppService.GetAppVersion()