Merge pull request #15 from AAStarCommunity/chao/chore/swag-update

bugfix: healthz && swagger update
AAStarCommunity · Mar 4, 2024 · 7fad9f9 · 7fad9f9
2 parents ebabc9f + 322adbf
commit 7fad9f9
Show file tree

Hide file tree

Showing 5 changed files with 44 additions and 8 deletions.
diff --git a/docs/docs.go b/docs/docs.go
@@ -1,5 +1,4 @@
-// Package docs GENERATED BY SWAG; DO NOT EDIT
-// This file was generated by swaggo/swag
+// Package docs Code generated by swaggo/swag. DO NOT EDIT
 package docs
 
 import "github.com/swaggo/swag"
@@ -46,6 +45,19 @@ const docTemplate = `{
  }
  }
  },
+ "/api/healthz": {
+ "get": {
+ "description": "Get Healthz",
+ "tags": [
+ "Healthz"
+ ],
+ "responses": {
+ "200": {
+ "description": "OK"
+ }
+ }
+ }
+ },
  "/api/v1/get-support-entrypoint": {
  "get": {
  "security": [
@@ -143,6 +155,8 @@ var SwaggerInfo = &swag.Spec{
  Description: "",
  InfoInstanceName: "swagger",
  SwaggerTemplate: docTemplate,
+ LeftDelim: "{{",
+ RightDelim: "}}",
 }
 
 func init() {

diff --git a/docs/swagger.json b/docs/swagger.json
@@ -34,6 +34,19 @@
  }
  }
  },
+ "/api/healthz": {
+ "get": {
+ "description": "Get Healthz",
+ "tags": [
+ "Healthz"
+ ],
+ "responses": {
+ "200": {
+ "description": "OK"
+ }
+ }
+ }
+ },
  "/api/v1/get-support-entrypoint": {
  "get": {
  "security": [

diff --git a/docs/swagger.yaml b/docs/swagger.yaml
@@ -26,6 +26,14 @@ paths:
  description: OK
  tags:
  - Auth
+ /api/healthz:
+ get:
+ description: Get Healthz
+ responses:
+ "200":
+ description: OK
+ tags:
+ - Healthz
  /api/v1/get-support-entrypoint:
  get:
  consumes:

diff --git a/rpc_server/api/health.go b/rpc_server/api/health.go
@@ -10,10 +10,7 @@ import (
 // Healthz
 // @Tags Healthz
 // @Description Get Healthz
-// @Accept json
-// @Product json
-// @Param
-// @Router /api/health [post,get,put,delete]
+// @Router /api/healthz [get]
 // @Success 200
 func Healthz(c *gin.Context) {
  response := models.GetResponse()
@@ -23,5 +20,4 @@ func Healthz(c *gin.Context) {
  "time": time.Now(),
  "version": "v1.0.0",
  })
- response.Success(c)
 }
diff --git a/rpc_server/routers/builder.go b/rpc_server/routers/builder.go
@@ -16,7 +16,12 @@ func buildRouters(router *gin.Engine, routerMaps []RouterMap) {
  router.POST(routerMap.Url, routerMap.Func)
  } else if method == DELETE {
  router.DELETE(routerMap.Url, routerMap.Func)
- } // ignore rest methods
+ } else if method == OPTIONS {
+ router.OPTIONS(routerMap.Url, routerMap.Func)
+ } else if method == HEAD {
+ router.HEAD(routerMap.Url, routerMap.Func)
+ }
+ // ignore rest methods
  }
 
  }