update limiter

This commit is contained in:
ginuerzh
2022-09-14 20:00:35 +08:00
parent 91c12882f5
commit 01d7dc77c6
34 changed files with 1171 additions and 79 deletions

View File

@ -120,7 +120,7 @@ func updateConnLimiter(ctx *gin.Context) {
type deleteConnLimiterRequest struct {
// in: path
// required: true
Limiter string `uri:"Limiter" json:"Limiter"`
Limiter string `uri:"limiter" json:"limiter"`
}
// successful operation.

View File

@ -120,7 +120,7 @@ func updateLimiter(ctx *gin.Context) {
type deleteLimiterRequest struct {
// in: path
// required: true
Limiter string `uri:"Limiter" json:"Limiter"`
Limiter string `uri:"limiter" json:"limiter"`
}
// successful operation.

166
api/config_rate_limiter.go Normal file
View File

@ -0,0 +1,166 @@
package api
import (
"net/http"
"github.com/gin-gonic/gin"
"github.com/go-gost/x/config"
"github.com/go-gost/x/config/parsing"
"github.com/go-gost/x/registry"
)
// swagger:parameters createRateLimiterRequest
type createRateLimiterRequest struct {
// in: body
Data config.LimiterConfig `json:"data"`
}
// successful operation.
// swagger:response createRateLimiterResponse
type createRateLimiterResponse struct {
Data Response
}
func createRateLimiter(ctx *gin.Context) {
// swagger:route POST /config/rlimiters Limiter createRateLimiterRequest
//
// Create a new rate limiter, the name of limiter must be unique in limiter list.
//
// Security:
// basicAuth: []
//
// Responses:
// 200: createRateLimiterResponse
var req createRateLimiterRequest
ctx.ShouldBindJSON(&req.Data)
if req.Data.Name == "" {
writeError(ctx, ErrInvalid)
return
}
v := parsing.ParseRateLimiter(&req.Data)
if err := registry.RateLimiterRegistry().Register(req.Data.Name, v); err != nil {
writeError(ctx, ErrDup)
return
}
cfg := config.Global()
cfg.CLimiters = append(cfg.CLimiters, &req.Data)
config.SetGlobal(cfg)
ctx.JSON(http.StatusOK, Response{
Msg: "OK",
})
}
// swagger:parameters updateRateLimiterRequest
type updateRateLimiterRequest struct {
// in: path
// required: true
Limiter string `uri:"limiter" json:"limiter"`
// in: body
Data config.LimiterConfig `json:"data"`
}
// successful operation.
// swagger:response updateRateLimiterResponse
type updateRateLimiterResponse struct {
Data Response
}
func updateRateLimiter(ctx *gin.Context) {
// swagger:route PUT /config/rlimiters/{limiter} Limiter updateRateLimiterRequest
//
// Update rate limiter by name, the limiter must already exist.
//
// Security:
// basicAuth: []
//
// Responses:
// 200: updateRateLimiterResponse
var req updateRateLimiterRequest
ctx.ShouldBindUri(&req)
ctx.ShouldBindJSON(&req.Data)
if !registry.RateLimiterRegistry().IsRegistered(req.Limiter) {
writeError(ctx, ErrNotFound)
return
}
req.Data.Name = req.Limiter
v := parsing.ParseRateLimiter(&req.Data)
registry.RateLimiterRegistry().Unregister(req.Limiter)
if err := registry.RateLimiterRegistry().Register(req.Limiter, v); err != nil {
writeError(ctx, ErrDup)
return
}
cfg := config.Global()
for i := range cfg.Limiters {
if cfg.Limiters[i].Name == req.Limiter {
cfg.Limiters[i] = &req.Data
break
}
}
config.SetGlobal(cfg)
ctx.JSON(http.StatusOK, Response{
Msg: "OK",
})
}
// swagger:parameters deleteRateLimiterRequest
type deleteRateLimiterRequest struct {
// in: path
// required: true
Limiter string `uri:"limiter" json:"limiter"`
}
// successful operation.
// swagger:response deleteRateLimiterResponse
type deleteRateLimiterResponse struct {
Data Response
}
func deleteRateLimiter(ctx *gin.Context) {
// swagger:route DELETE /config/rlimiters/{limiter} Limiter deleteRateLimiterRequest
//
// Delete rate limiter by name.
//
// Security:
// basicAuth: []
//
// Responses:
// 200: deleteRateLimiterResponse
var req deleteRateLimiterRequest
ctx.ShouldBindUri(&req)
if !registry.RateLimiterRegistry().IsRegistered(req.Limiter) {
writeError(ctx, ErrNotFound)
return
}
registry.RateLimiterRegistry().Unregister(req.Limiter)
cfg := config.Global()
limiteres := cfg.Limiters
cfg.Limiters = nil
for _, s := range limiteres {
if s.Name == req.Limiter {
continue
}
cfg.Limiters = append(cfg.Limiters, s)
}
config.SetGlobal(cfg)
ctx.JSON(http.StatusOK, Response{
Msg: "OK",
})
}

View File

@ -137,4 +137,8 @@ func registerConfig(config *gin.RouterGroup) {
config.POST("/climiters", createConnLimiter)
config.PUT("/climiters/:limiter", updateConnLimiter)
config.DELETE("/climiters/:limiter", deleteConnLimiter)
config.POST("/rlimiters", createRateLimiter)
config.PUT("/rlimiters/:limiter", updateRateLimiter)
config.DELETE("/rlimiters/:limiter", deleteRateLimiter)
}

View File

@ -151,6 +151,11 @@ definitions:
$ref: '#/definitions/ChainConfig'
type: array
x-go-name: Chains
climiters:
items:
$ref: '#/definitions/LimiterConfig'
type: array
x-go-name: CLimiters
hosts:
items:
$ref: '#/definitions/HostsConfig'
@ -177,6 +182,11 @@ definitions:
$ref: '#/definitions/ResolverConfig'
type: array
x-go-name: Resolvers
rlimiters:
items:
$ref: '#/definitions/LimiterConfig'
type: array
x-go-name: RLimiters
services:
items:
$ref: '#/definitions/ServiceConfig'
@ -358,11 +368,20 @@ definitions:
x-go-package: github.com/go-gost/x/config
LimiterConfig:
properties:
file:
$ref: '#/definitions/FileLoader'
limits:
items:
type: string
type: array
x-go-name: Limits
name:
type: string
x-go-name: Name
rate:
$ref: '#/definitions/RateLimiterConfig'
redis:
$ref: '#/definitions/RedisLoader'
reload:
$ref: '#/definitions/Duration'
type: object
x-go-package: github.com/go-gost/x/config
ListenerConfig:
@ -483,21 +502,6 @@ definitions:
x-go-name: Addr
type: object
x-go-package: github.com/go-gost/x/config
RateLimiterConfig:
properties:
file:
$ref: '#/definitions/FileLoader'
limits:
items:
type: string
type: array
x-go-name: Limits
redis:
$ref: '#/definitions/RedisLoader'
reload:
$ref: '#/definitions/Duration'
type: object
x-go-package: github.com/go-gost/x/config
RecorderConfig:
properties:
file:
@ -616,6 +620,9 @@ definitions:
type: string
type: array
x-go-name: Bypasses
climiter:
type: string
x-go-name: CLimiter
forwarder:
$ref: '#/definitions/ForwarderConfig'
handler:
@ -624,6 +631,7 @@ definitions:
type: string
x-go-name: Hosts
interface:
description: DEPRECATED by metadata.interface since beta.5
type: string
x-go-name: Interface
limiter:
@ -646,6 +654,9 @@ definitions:
resolver:
type: string
x-go-name: Resolver
rlimiter:
type: string
x-go-name: RLimiter
sockopts:
$ref: '#/definitions/SockOptsConfig'
type: object
@ -956,6 +967,64 @@ paths:
summary: Update chain by name, the chain must already exist.
tags:
- Chain
/config/climiters:
post:
operationId: createConnLimiterRequest
parameters:
- in: body
name: data
schema:
$ref: '#/definitions/LimiterConfig'
x-go-name: Data
responses:
"200":
$ref: '#/responses/createConnLimiterResponse'
security:
- basicAuth:
- '[]'
summary: Create a new conn limiter, the name of limiter must be unique in limiter list.
tags:
- Limiter
/config/climiters/{limiter}:
delete:
operationId: deleteConnLimiterRequest
parameters:
- in: path
name: limiter
required: true
type: string
x-go-name: Limiter
responses:
"200":
$ref: '#/responses/deleteConnLimiterResponse'
security:
- basicAuth:
- '[]'
summary: Delete conn limiter by name.
tags:
- Limiter
put:
operationId: updateConnLimiterRequest
parameters:
- in: path
name: limiter
required: true
type: string
x-go-name: Limiter
- in: body
name: data
schema:
$ref: '#/definitions/LimiterConfig'
x-go-name: Data
responses:
"200":
$ref: '#/responses/updateConnLimiterResponse'
security:
- basicAuth:
- '[]'
summary: Update conn limiter by name, the limiter must already exist.
tags:
- Limiter
/config/hosts:
post:
operationId: createHostsRequest
@ -1037,9 +1106,10 @@ paths:
operationId: deleteLimiterRequest
parameters:
- in: path
name: Limiter
name: limiter
required: true
type: string
x-go-name: Limiter
responses:
"200":
$ref: '#/responses/deleteLimiterResponse'
@ -1129,6 +1199,64 @@ paths:
summary: Update resolver by name, the resolver must already exist.
tags:
- Resolver
/config/rlimiters:
post:
operationId: createRateLimiterRequest
parameters:
- in: body
name: data
schema:
$ref: '#/definitions/LimiterConfig'
x-go-name: Data
responses:
"200":
$ref: '#/responses/createRateLimiterResponse'
security:
- basicAuth:
- '[]'
summary: Create a new rate limiter, the name of limiter must be unique in limiter list.
tags:
- Limiter
/config/rlimiters/{limiter}:
delete:
operationId: deleteRateLimiterRequest
parameters:
- in: path
name: limiter
required: true
type: string
x-go-name: Limiter
responses:
"200":
$ref: '#/responses/deleteRateLimiterResponse'
security:
- basicAuth:
- '[]'
summary: Delete rate limiter by name.
tags:
- Limiter
put:
operationId: updateRateLimiterRequest
parameters:
- in: path
name: limiter
required: true
type: string
x-go-name: Limiter
- in: body
name: data
schema:
$ref: '#/definitions/LimiterConfig'
x-go-name: Data
responses:
"200":
$ref: '#/responses/updateRateLimiterResponse'
security:
- basicAuth:
- '[]'
summary: Update rate limiter by name, the limiter must already exist.
tags:
- Limiter
/config/services:
post:
operationId: createServiceRequest
@ -1214,6 +1342,12 @@ responses:
Data: {}
schema:
$ref: '#/definitions/Response'
createConnLimiterResponse:
description: successful operation.
headers:
Data: {}
schema:
$ref: '#/definitions/Response'
createHostsResponse:
description: successful operation.
headers:
@ -1226,6 +1360,12 @@ responses:
Data: {}
schema:
$ref: '#/definitions/Response'
createRateLimiterResponse:
description: successful operation.
headers:
Data: {}
schema:
$ref: '#/definitions/Response'
createResolverResponse:
description: successful operation.
headers:
@ -1262,6 +1402,12 @@ responses:
Data: {}
schema:
$ref: '#/definitions/Response'
deleteConnLimiterResponse:
description: successful operation.
headers:
Data: {}
schema:
$ref: '#/definitions/Response'
deleteHostsResponse:
description: successful operation.
headers:
@ -1274,6 +1420,12 @@ responses:
Data: {}
schema:
$ref: '#/definitions/Response'
deleteRateLimiterResponse:
description: successful operation.
headers:
Data: {}
schema:
$ref: '#/definitions/Response'
deleteResolverResponse:
description: successful operation.
headers:
@ -1322,6 +1474,12 @@ responses:
Data: {}
schema:
$ref: '#/definitions/Response'
updateConnLimiterResponse:
description: successful operation.
headers:
Data: {}
schema:
$ref: '#/definitions/Response'
updateHostsResponse:
description: successful operation.
headers:
@ -1334,6 +1492,12 @@ responses:
Data: {}
schema:
$ref: '#/definitions/Response'
updateRateLimiterResponse:
description: successful operation.
headers:
Data: {}
schema:
$ref: '#/definitions/Response'
updateResolverResponse:
description: successful operation.
headers: