chore: improve swagger path

CAS735-F23 · Dec 6, 2023 · dcd9ad7 · dcd9ad7
1 parent 9b7bf2f
commit dcd9ad7
Show file tree

Hide file tree

Showing 4 changed files with 34 additions and 3 deletions.
diff --git a/game-service/api/server.go b/game-service/api/server.go
@@ -41,16 +41,23 @@ func New(app *game.App) *gin.Engine {
 	// index page
 	r.GET("/", getIndex())
 
-	docs.SwaggerInfo.BasePath = "/game"
-	r.GET("/game-swagger/*any", ginSwagger.WrapHandler(swaggerfiles.Handler))
-
 	gm := r.Group("/game")
 	{
 		gm.POST("/start", handleGameStart(app))
 		gm.POST("/stop", handleGameStop(app))
 		gm.POST("/action", handleGameAction(app))
 	}
 
+	docs.SwaggerInfo.BasePath = "/game"
+
+	sw := r.Group("/game-swagger")
+	{
+		sw.GET("/index.html", func(c *gin.Context) {
+			c.Redirect(http.StatusTemporaryRedirect, "/game-swagger/swagger-ui/index.html")
+		})
+		sw.GET("/swagger-ui/*any", ginSwagger.WrapHandler(swaggerfiles.Handler))
+	}
+
 	return r
 }
 

diff --git a/game-service/docs/docs.go b/game-service/docs/docs.go
@@ -97,6 +97,15 @@ const docTemplate = `{
                         "schema": {
                             "type": "string"
                         }
+                    },
+                    {
+                        "description": "player current location",
+                        "name": "location",
+                        "in": "body",
+                        "required": true,
+                        "schema": {
+                            "$ref": "#/definitions/dto.PointDTO"
+                        }
                     }
                 ],
                 "responses": {

diff --git a/game-service/docs/swagger.json b/game-service/docs/swagger.json
@@ -86,6 +86,15 @@
                         "schema": {
                             "type": "string"
                         }
+                    },
+                    {
+                        "description": "player current location",
+                        "name": "location",
+                        "in": "body",
+                        "required": true,
+                        "schema": {
+                            "$ref": "#/definitions/dto.PointDTO"
+                        }
                     }
                 ],
                 "responses": {

diff --git a/game-service/docs/swagger.yaml b/game-service/docs/swagger.yaml
@@ -68,6 +68,12 @@ paths:
         required: true
         schema:
           type: string
+      - description: player current location
+        in: body
+        name: location
+        required: true
+        schema:
+          $ref: '#/definitions/dto.PointDTO'
       produces:
       - application/json
       responses: