Files
godoxy-yusing/internal/api/v1/route/list.go
yusing f6a82a3b7c docs(api): update swagger docs with field descriptions and operationId rename
- Add minimum: 0 validation to LogRetention properties (days, keep_size, last)
- Add "interned" descriptions to fstype, path, and name fields
- Rename operationId and x-id from "routes" to "list" for GET /route endpoint
2026-02-22 19:54:56 +08:00

73 lines
1.6 KiB
Go

package routeApi
import (
"net/http"
"slices"
"time"
"github.com/gin-gonic/gin"
entrypoint "github.com/yusing/godoxy/internal/entrypoint/types"
"github.com/yusing/godoxy/internal/route"
"github.com/yusing/godoxy/internal/types"
"github.com/yusing/goutils/http/httpheaders"
"github.com/yusing/goutils/http/websocket"
)
type RouteType route.Route // @name Route
// @x-id "list"
// @BasePath /api/v1
// @Summary List routes
// @Description List routes
// @Tags route,websocket
// @Accept json
// @Produce json
// @Param provider query string false "Provider"
// @Success 200 {array} RouteType
// @Failure 403 {object} apitypes.ErrorResponse
// @Router /route/list [get]
func Routes(c *gin.Context) {
if httpheaders.IsWebsocket(c.Request.Header) {
RoutesWS(c)
return
}
ep := entrypoint.FromCtx(c.Request.Context())
provider := c.Query("provider")
if provider == "" {
c.JSON(http.StatusOK, slices.Collect(ep.IterRoutes))
return
}
rts := make([]types.Route, 0, ep.NumRoutes())
for r := range ep.IterRoutes {
if r.ProviderName() == provider {
rts = append(rts, r)
}
}
c.JSON(http.StatusOK, rts)
}
func RoutesWS(c *gin.Context) {
ep := entrypoint.FromCtx(c.Request.Context())
provider := c.Query("provider")
if provider == "" {
websocket.PeriodicWrite(c, 3*time.Second, func() (any, error) {
return slices.Collect(ep.IterRoutes), nil
})
return
}
websocket.PeriodicWrite(c, 3*time.Second, func() (any, error) {
rts := make([]types.Route, 0, ep.NumRoutes())
for r := range ep.IterRoutes {
if r.ProviderName() == provider {
rts = append(rts, r)
}
}
return rts, nil
})
}