6434438023/oph24 8 documentation swagger

.env.example

@@ -6,10 +6,11 @@ REDIS_PASSWORD=123456
 
 APP_PORT=3000
 APP_ENV=development
+APP_HOST=127.0.0.1:3000
 
 OAUTH2_CLIENT_ID=123456
 OAUTH2_CLIENT_SECRET=123456
 OAUTH2_REDIRECT_URL=http://localhost:3000/auth/callback
 OAUTH2_SCOPES=openid,email
 
-CORS_ORIGINS=https://openhouse.chula.ac.th,https://isd-sgcu.in.th,https://openhouse.isd-sgcu.in.th
+CORS_ORIGINS=https://openhouse.chula.ac.th,https://isd-sgcu.in.th,https://openhouse.isd-sgcu.in.th

cfgldr/cfgldr.go

@@ -19,6 +19,7 @@ type DatabaseConfig struct {
 type AppConfig struct {
 	Port string `mapstructure:"PORT"`
 	Env  string `mapstructure:"ENV"`
+	Host string `mapstructure:"HOST"`
 }
 
 type RedisConfig struct {

cmd/main.go

@@ -5,22 +5,34 @@ import (
 
 	"github.com/gin-gonic/gin"
 	"github.com/isd-sgcu/oph66-backend/di"
+	"github.com/isd-sgcu/oph66-backend/docs"
+	swaggerFiles "github.com/swaggo/files"
+	ginSwagger "github.com/swaggo/gin-swagger"
 )
 
+// @title                      OPH-66 Backend API
+// @version                    1.0
+// @description                Documentation outlines the specifications and endpoints for the OPH-66 Backend API.
+// @Schemes                    http https
+// @securityDefinitions.apikey Bearer
+// @in                         header
+// @name                       Authorization
+// @description                Type "Bearer" followed by a space and JWT token.
 func main() {
 	container, err := di.Init()
 	if err != nil {
 		panic(fmt.Sprintf("unable to init di: %v", err))
 	}
 	container.Logger.Info("init container successfully")
 
+	docs.SwaggerInfo.Host = container.Config.AppConfig.Host
+
 	if !container.Config.AppConfig.IsDevelopment() {
 		gin.SetMode(gin.ReleaseMode)
 	}
 	r := gin.Default()
 
 	r.Use(gin.HandlerFunc(container.CorsHandler))
-
 	r.GET("/_hc", container.HcHandler.HealthCheck)
 	r.GET("/live", container.FeatureflagHandler.GetLivestreamInfo)
 	r.GET("/events", container.EventHandler.GetAllEvents)
@@ -30,6 +42,9 @@ func main() {
 	r.GET("/auth/login", container.AuthHandler.GoogleLogin)
 	r.GET("/auth/callback", container.AuthHandler.GoogleCallback)
 
+	if container.Config.AppConfig.Env == "development" {
+		r.GET("/swagger/*any", ginSwagger.WrapHandler(swaggerFiles.Handler))
+	}
 	if err := r.Run(fmt.Sprintf(":%v", container.Config.AppConfig.Port)); err != nil {
 		container.Logger.Fatal("unable to start server")
 	}