📝 Add docstrings to wh/service-gateway

Docstrings generation was requested by @wuhan005.

* #70 (comment)

The following files were modified:

* `internal/conf/conf.go`
* `internal/route/route.go`
* `route/service/proxy.go`

Author: coderabbitai[bot]

internal/conf/conf.go

@@ -15,6 +15,18 @@ import (
 // File is the configuration object.
 var File *ini.File
 
+// Init loads and initializes package configuration from an INI file.
+// 
+// It reads NEKOBOX_CONFIG_PATH to determine the config file path (defaults to "conf/app.ini"),
+// parses the INI file with inline comments ignored, and maps INI sections into the package-level
+// configuration structs (App, Security, Server, Database, Redis, Recaptcha, Pixel, Upload, Mail).
+// It requires App.ExternalURL to be set and trims any trailing slash from it.
+// 
+// Service child sections under the "service" section are each mapped into a backend with
+// `prefix` and `forward_url` fields and appended to Service.Backends.
+// 
+// On success it returns nil. It returns a wrapped error if the file cannot be parsed or if any
+// section mapping (including individual service subsections) fails, or if App.ExternalURL is empty.
 func Init() error {
 	configFile := os.Getenv("NEKOBOX_CONFIG_PATH")
 	if configFile == "" {
@@ -84,4 +96,4 @@ func Init() error {
 	}
 
 	return nil
-}
+}

internal/route/route.go

@@ -35,6 +35,9 @@ import (
 	"github.com/wuhan005/NekoBox/templates"
 )
 
+// New creates and returns a fully configured Flamego application.
+//
+// The returned instance is configured with environment mode (production when enabled), embedded HTML templates, session storage (memory, MySQL, or Redis depending on configuration), static file serving, route groups and handlers (including web and API endpoints), common middleware (cache, reCAPTCHA v3, session, CSRF, templating, and custom context), and a NotFound handler that redirects to "/".
 func New() *flamego.Flame {
 	f := flamego.Classic()
 	if conf.App.Production {
@@ -183,4 +186,4 @@ func New() *flamego.Flame {
 	})
 
 	return f
-}
+}

route/service/proxy.go

@@ -18,6 +18,10 @@ import (
 	"github.com/wuhan005/NekoBox/internal/context"
 )
 
+// Proxy forwards the incoming request to a configured backend based on the request path,
+// propagates tracing headers and the authenticated user ID, and writes the proxied response back to the client.
+// It returns an error when the request could not be proxied and an HTTP error response was written
+// (for example when no backend matches or when the backend URL is invalid); otherwise it returns nil.
 func Proxy(ctx context.Context) error {
 	span := trace.SpanFromContext(ctx.Request().Context())
 
@@ -81,4 +85,4 @@ func Proxy(ctx context.Context) error {
 
 	reverseProxy.ServeHTTP(ctx.ResponseWriter(), ctx.Request().Request)
 	return nil
-}
+}