mirror of
https://github.com/yusing/godoxy.git
synced 2026-04-22 16:58:54 +02:00
refactor(api): restructured API for type safety, maintainability and docs generation
- These changes makes the API incombatible with previous versions - Added new types for error handling, success responses, and health checks. - Updated health check logic to utilize the new types for better clarity and structure. - Refactored existing handlers to improve response consistency and error handling. - Updated Makefile to include a new target for generating API types from Swagger. - Updated "new agent" API to respond an encrypted cert pair
This commit is contained in:
yusing
73
internal/api/v1/file/get.go
Normal file
73
internal/api/v1/file/get.go
Normal file
@@ -0,0 +1,73 @@
|
||||
package fileapi
|
||||
|
||||
import (
|
||||
"net/http"
|
||||
"os"
|
||||
"path"
|
||||
"strings"
|
||||
|
||||
"github.com/gin-gonic/gin"
|
||||
apitypes "github.com/yusing/go-proxy/internal/api/types"
|
||||
"github.com/yusing/go-proxy/internal/common"
|
||||
)
|
||||
|
||||
type FileType string // @name FileType
|
||||
|
||||
const (
|
||||
FileTypeConfig FileType = "config" // @name FileTypeConfig
|
||||
FileTypeProvider FileType = "provider" // @name FileTypeProvider
|
||||
FileTypeMiddleware FileType = "middleware" // @name FileTypeMiddleware
|
||||
)
|
||||
|
||||
type GetFileContentRequest struct {
|
||||
FileType FileType `form:"type" binding:"required,oneof=config provider middleware"`
|
||||
Filename string `form:"filename" binding:"required" format:"filename"`
|
||||
} // @name GetFileContentRequest
|
||||
|
||||
// @x-id "get"
|
||||
// @BasePath /api/v1
|
||||
// @Summary Get file content
|
||||
// @Description Get file content
|
||||
// @Tags file
|
||||
// @Accept json
|
||||
// @Produce json,application/godoxy+yaml
|
||||
// @Param query query GetFileContentRequest true "Request"
|
||||
// @Success 200 {string} application/godoxy+yaml "File content"
|
||||
// @Failure 400 {object} apitypes.ErrorResponse
|
||||
// @Failure 403 {object} apitypes.ErrorResponse
|
||||
// @Failure 500 {object} apitypes.ErrorResponse
|
||||
// @Router /file/content [get]
|
||||
func Get(c *gin.Context) {
|
||||
var request GetFileContentRequest
|
||||
if err := c.ShouldBindQuery(&request); err != nil {
|
||||
c.JSON(http.StatusBadRequest, apitypes.Error("invalid request", err))
|
||||
return
|
||||
}
|
||||
|
||||
content, err := os.ReadFile(request.FileType.GetPath(request.Filename))
|
||||
if err != nil {
|
||||
c.Error(apitypes.InternalServerError(err, "failed to read file"))
|
||||
return
|
||||
}
|
||||
|
||||
// RFC 9512: https://www.rfc-editor.org/rfc/rfc9512.html
|
||||
// xxx/yyy+yaml
|
||||
c.Data(http.StatusOK, "application/godoxy+yaml", content)
|
||||
}
|
||||
|
||||
func GetFileType(file string) FileType {
|
||||
switch {
|
||||
case strings.HasPrefix(path.Base(file), "config."):
|
||||
return FileTypeConfig
|
||||
case strings.HasPrefix(file, common.MiddlewareComposeBasePath):
|
||||
return FileTypeMiddleware
|
||||
}
|
||||
return FileTypeProvider
|
||||
}
|
||||
|
||||
func (t FileType) GetPath(filename string) string {
|
||||
if t == FileTypeMiddleware {
|
||||
return path.Join(common.MiddlewareComposeBasePath, filename)
|
||||
}
|
||||
return path.Join(common.ConfigBasePath, filename)
|
||||
}
|
||||
62
internal/api/v1/file/list.go
Normal file
62
internal/api/v1/file/list.go
Normal file
@@ -0,0 +1,62 @@
|
||||
package fileapi
|
||||
|
||||
import (
|
||||
"net/http"
|
||||
"strings"
|
||||
|
||||
"github.com/gin-gonic/gin"
|
||||
apitypes "github.com/yusing/go-proxy/internal/api/types"
|
||||
"github.com/yusing/go-proxy/internal/common"
|
||||
"github.com/yusing/go-proxy/internal/utils"
|
||||
)
|
||||
|
||||
type ListFilesResponse struct {
|
||||
Config []string `json:"config"`
|
||||
Provider []string `json:"provider"`
|
||||
Middleware []string `json:"middleware"`
|
||||
} // @name ListFilesResponse
|
||||
|
||||
// @x-id "list"
|
||||
// @BasePath /api/v1
|
||||
// @Summary List files
|
||||
// @Description List files
|
||||
// @Tags file
|
||||
// @Accept json
|
||||
// @Produce json
|
||||
// @Success 200 {object} ListFilesResponse
|
||||
// @Failure 403 {object} apitypes.ErrorResponse
|
||||
// @Failure 500 {object} apitypes.ErrorResponse
|
||||
// @Router /file/list [get]
|
||||
func List(c *gin.Context) {
|
||||
resp := map[FileType][]string{
|
||||
FileTypeConfig: make([]string, 0),
|
||||
FileTypeProvider: make([]string, 0),
|
||||
FileTypeMiddleware: make([]string, 0),
|
||||
}
|
||||
|
||||
// config/
|
||||
files, err := utils.ListFiles(common.ConfigBasePath, 0, true)
|
||||
if err != nil {
|
||||
c.Error(apitypes.InternalServerError(err, "failed to list files"))
|
||||
return
|
||||
}
|
||||
|
||||
for _, file := range files {
|
||||
t := GetFileType(file)
|
||||
file = strings.TrimPrefix(file, common.ConfigBasePath+"/")
|
||||
resp[t] = append(resp[t], file)
|
||||
}
|
||||
|
||||
// config/middlewares/
|
||||
mids, err := utils.ListFiles(common.MiddlewareComposeBasePath, 0, true)
|
||||
if err != nil {
|
||||
c.Error(apitypes.InternalServerError(err, "failed to list files"))
|
||||
return
|
||||
}
|
||||
for _, mid := range mids {
|
||||
mid = strings.TrimPrefix(mid, common.MiddlewareComposeBasePath+"/")
|
||||
resp[FileTypeMiddleware] = append(resp[FileTypeMiddleware], mid)
|
||||
}
|
||||
|
||||
c.JSON(http.StatusOK, resp)
|
||||
}
|
||||
52
internal/api/v1/file/set.go
Normal file
52
internal/api/v1/file/set.go
Normal file
@@ -0,0 +1,52 @@
|
||||
package fileapi
|
||||
|
||||
import (
|
||||
"net/http"
|
||||
"os"
|
||||
|
||||
"github.com/gin-gonic/gin"
|
||||
apitypes "github.com/yusing/go-proxy/internal/api/types"
|
||||
)
|
||||
|
||||
type SetFileContentRequest GetFileContentRequest
|
||||
|
||||
// @x-id "set"
|
||||
// @BasePath /api/v1
|
||||
// @Summary Set file content
|
||||
// @Description Set file content
|
||||
// @Tags file
|
||||
// @Accept json
|
||||
// @Produce json
|
||||
// @Param type query FileType true "Type"
|
||||
// @Param filename query string true "Filename"
|
||||
// @Param file body string true "File"
|
||||
// @Success 200 {object} apitypes.SuccessResponse
|
||||
// @Failure 400 {object} apitypes.ErrorResponse
|
||||
// @Failure 403 {object} apitypes.ErrorResponse
|
||||
// @Failure 500 {object} apitypes.ErrorResponse
|
||||
// @Router /file/content [put]
|
||||
func Set(c *gin.Context) {
|
||||
var request SetFileContentRequest
|
||||
if err := c.ShouldBindQuery(&request); err != nil {
|
||||
c.JSON(http.StatusBadRequest, apitypes.Error("invalid request", err))
|
||||
return
|
||||
}
|
||||
|
||||
content, err := c.GetRawData()
|
||||
if err != nil {
|
||||
c.Error(apitypes.InternalServerError(err, "failed to read file"))
|
||||
return
|
||||
}
|
||||
|
||||
if valErr := validateFile(request.FileType, content); valErr != nil {
|
||||
c.JSON(http.StatusBadRequest, apitypes.Error("invalid file", valErr))
|
||||
return
|
||||
}
|
||||
|
||||
err = os.WriteFile(request.FileType.GetPath(request.Filename), content, 0o644)
|
||||
if err != nil {
|
||||
c.Error(apitypes.InternalServerError(err, "failed to write file"))
|
||||
return
|
||||
}
|
||||
c.JSON(http.StatusOK, apitypes.Success("file set"))
|
||||
}
|
||||
64
internal/api/v1/file/validate.go
Normal file
64
internal/api/v1/file/validate.go
Normal file
@@ -0,0 +1,64 @@
|
||||
package fileapi
|
||||
|
||||
import (
|
||||
"net/http"
|
||||
|
||||
"github.com/gin-gonic/gin"
|
||||
apitypes "github.com/yusing/go-proxy/internal/api/types"
|
||||
config "github.com/yusing/go-proxy/internal/config/types"
|
||||
"github.com/yusing/go-proxy/internal/gperr"
|
||||
"github.com/yusing/go-proxy/internal/net/gphttp/middleware"
|
||||
"github.com/yusing/go-proxy/internal/route/provider"
|
||||
)
|
||||
|
||||
type ValidateFileRequest struct {
|
||||
FileType FileType `form:"type" validate:"required,oneof=config provider middleware"`
|
||||
} // @name ValidateFileRequest
|
||||
|
||||
// @x-id "validate"
|
||||
// @BasePath /api/v1
|
||||
// @Summary Validate file
|
||||
// @Description Validate file
|
||||
// @Tags file
|
||||
// @Accept json
|
||||
// @Produce json
|
||||
// @Param type query FileType true "Type"
|
||||
// @Param file body string true "File content"
|
||||
// @Success 200 {object} apitypes.SuccessResponse "File validated"
|
||||
// @Failure 400 {object} apitypes.ErrorResponse "Bad request"
|
||||
// @Failure 403 {object} apitypes.ErrorResponse "Forbidden"
|
||||
// @Failure 417 {object} apitypes.ErrorResponse "Validation failed"
|
||||
// @Failure 500 {object} apitypes.ErrorResponse "Internal server error"
|
||||
// @Router /file/validate [post]
|
||||
func Validate(c *gin.Context) {
|
||||
var request ValidateFileRequest
|
||||
if err := c.ShouldBindQuery(&request); err != nil {
|
||||
c.JSON(http.StatusBadRequest, apitypes.Error("invalid request", err))
|
||||
return
|
||||
}
|
||||
|
||||
content, err := c.GetRawData()
|
||||
if err != nil {
|
||||
c.Error(apitypes.InternalServerError(err, "failed to read file"))
|
||||
return
|
||||
}
|
||||
c.Request.Body.Close()
|
||||
|
||||
if valErr := validateFile(request.FileType, content); valErr != nil {
|
||||
c.JSON(http.StatusExpectationFailed, apitypes.Error("invalid file", valErr))
|
||||
return
|
||||
}
|
||||
c.JSON(http.StatusOK, apitypes.Success("file validated"))
|
||||
}
|
||||
|
||||
func validateFile(fileType FileType, content []byte) gperr.Error {
|
||||
switch fileType {
|
||||
case FileTypeConfig:
|
||||
return config.Validate(content)
|
||||
case FileTypeMiddleware:
|
||||
errs := gperr.NewBuilder("middleware errors")
|
||||
middleware.BuildMiddlewaresFromYAML("", content, errs)
|
||||
return errs.Error()
|
||||
}
|
||||
return provider.Validate(content)
|
||||
}
|
||||
Reference in New Issue
Block a user