mirror of
https://github.com/MHSanaei/3x-ui.git
synced 2026-08-21 10:27:14 +00:00
feat(api-docs): generate response examples from Go structs; fix SS2022 PSK regen (#4996)
Stop hand-writing OpenAPI response examples, which kept drifting from the real payloads (clients/traffic missing fields, inbounds/list exposing userId which is json:"-", the fictional inbound-443 tag instead of the real in-<port>-<transport> form).
tools/openapigen now emits frontend/src/generated/examples.ts: a per-struct example instance built from type defaults, validate oneof/min bounds, and example: struct tags, with nested-ref expansion and a cycle guard. build-openapi.mjs composes the {success,obj} envelope from it for any endpoint annotated with responseSchema (+ responseSchemaArray for lists); the hand-written response is dropped for those. Service DTOs InboundOption/ApiTokenView/ProbeResultUI are added to the walker.
#4996: client password regeneration now produces a valid Shadowsocks 2022 PSK (correct base64 length per cipher) when an SS2022 inbound is attached, in both the single and bulk client forms; backend surfaces ssMethod on /inbounds/options so the UI can pick the right length.
Also: Swagger UI persists the Authorization token across reloads (persistAuthorization).
This commit is contained in:
@@ -27,6 +27,7 @@ type Field struct {
|
||||
Skip bool
|
||||
Validate []ValidateRule
|
||||
Doc string
|
||||
Example string
|
||||
}
|
||||
|
||||
type TypeRef struct {
|
||||
@@ -59,10 +60,11 @@ type ValidateRule struct {
|
||||
Param string
|
||||
}
|
||||
|
||||
func parseStructTag(raw string) (json string, validate string, gormHasDash bool) {
|
||||
func parseStructTag(raw string) (json string, validate string, example string, gormHasDash bool) {
|
||||
tag := reflect.StructTag(strings.Trim(raw, "`"))
|
||||
json = tag.Get("json")
|
||||
validate = tag.Get("validate")
|
||||
example = tag.Get("example")
|
||||
if g := tag.Get("gorm"); g != "" {
|
||||
for part := range strings.SplitSeq(g, ";") {
|
||||
if strings.TrimSpace(part) == "-" {
|
||||
|
||||
Reference in New Issue
Block a user