juwan/juwan-backend
1
0
Fork 0
Code Issues Pull Requests Actions 3 Packages Projects Releases Wiki Activity

chore: regenerate swagger docs for all API services

Browse Source
This commit is contained in:
zetaloop
2026-04-22 22:31:25 +08:00
parent 2d45d7e3cb
commit 6f2773273e
9 changed files with 1297 additions and 150 deletions
Download Patch File Download Diff File Expand all files Collapse all files
desc/api/docs/community-api.json
+1067
View File
File diff suppressed because it is too large Load Diff
desc/api/docs/email-api.json
+121
View File
@@ -0,0 +1,121 @@
{
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"schemes": [
"https"
],
"swagger": "2.0",
"info": {
"version": "1.0"
},
"basePath": "/",
"paths": {
"/api/v1/auth/forgot-password/send": {
"post": {
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"schemes": [
"https"
],
"summary": "忘记密码-发送验证码",
"operationId": "emailForgotPassword",
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"type": "object",
"required": [
"email"
],
"properties": {
"email": {
"type": "string"
}
}
}
}
],
"responses": {
"200": {
"description": "",
"schema": {
"type": "object"
}
}
}
}
},
"/api/v1/email/verification-code/send": {
"post": {
"description": "向用户邮箱发送验证码，支持注册、登录、重置密码、绑定邮箱等场景",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"schemes": [
"https"
],
"summary": "发送邮箱验证码",
"operationId": "emailSendVerificationCode",
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"type": "object",
"required": [
"email",
"scene"
],
"properties": {
"email": {
"type": "string"
},
"scene": {
"type": "string"
}
}
}
}
],
"responses": {
"200": {
"description": "",
"schema": {
"type": "object",
"properties": {
"expireInSec": {
"type": "integer"
},
"message": {
"type": "string"
},
"requestId": {
"type": "string"
}
}
}
}
}
}
}
},
"x-date": "2026-04-22 22:30:26",
"x-description": "This is a goctl generated swagger file.",
"x-github": "https://github.com/zeromicro/go-zero",
"x-go-zero-doc": "https://go-zero.dev/",
"x-goctl-version": "1.10.1"
}
desc/api/docs/game-api.json
+4 -5
View File
@@ -10,7 +10,6 @@
], ],
"swagger": "2.0", "swagger": "2.0",
"info": { "info": {
"title": "game-api",
"version": "1.0" "version": "1.0"
}, },
"basePath": "/", "basePath": "/",
@@ -29,6 +28,7 @@
{ {
"type": "integer", "type": "integer",
"default": 0, "default": 0,
"example": 0,
"name": "offset", "name": "offset",
"in": "query", "in": "query",
"required": true "required": true
@@ -36,6 +36,7 @@
{ {
"type": "integer", "type": "integer",
"default": 20, "default": 20,
"example": 20,
"name": "limit", "name": "limit",
"in": "query", "in": "query",
"required": true "required": true
@@ -52,7 +53,6 @@
"items": { "items": {
"type": "object", "type": "object",
"required": [ "required": [
"id",
"name", "name",
"icon", "icon",
"category" "category"
@@ -117,7 +117,6 @@
"schema": { "schema": {
"type": "object", "type": "object",
"required": [ "required": [
"id",
"name", "name",
"icon", "icon",
"category" "category"
@@ -206,9 +205,9 @@
} }
} }
}, },
"x-date": "2026-03-23 01:44:01", "x-date": "2026-04-22 22:30:23",
"x-description": "This is a goctl generated swagger file.", "x-description": "This is a goctl generated swagger file.",
"x-github": "https://github.com/zeromicro/go-zero", "x-github": "https://github.com/zeromicro/go-zero",
"x-go-zero-doc": "https://go-zero.dev/", "x-go-zero-doc": "https://go-zero.dev/",
"x-goctl-version": "1.9.2" "x-goctl-version": "1.10.1"
} }
desc/api/docs/os-api.json → desc/api/docs/objectstory-api.json
+5 -5
View File
@@ -15,7 +15,7 @@
}, },
"basePath": "/", "basePath": "/",
"paths": { "paths": {
"/api/v1/files/{fileId}": { "/api/v1/files": {
"get": { "get": {
"produces": [ "produces": [
"application/json" "application/json"
@@ -28,8 +28,8 @@
"parameters": [ "parameters": [
{ {
"type": "string", "type": "string",
"name": "fileId", "name": "key",
"in": "path", "in": "query",
"required": true "required": true
} }
], ],
@@ -87,9 +87,9 @@
} }
} }
}, },
"x-date": "2026-03-26 17:05:36", "x-date": "2026-04-22 22:30:27",
"x-description": "This is a goctl generated swagger file.", "x-description": "This is a goctl generated swagger file.",
"x-github": "https://github.com/zeromicro/go-zero", "x-github": "https://github.com/zeromicro/go-zero",
"x-go-zero-doc": "https://go-zero.dev/", "x-go-zero-doc": "https://go-zero.dev/",
"x-goctl-version": "1.9.2" "x-goctl-version": "1.10.1"
} }
desc/api/docs/order-api.json
+4 -55
View File
@@ -29,6 +29,7 @@
{ {
"type": "integer", "type": "integer",
"default": 0, "default": 0,
"example": 0,
"name": "offset", "name": "offset",
"in": "query", "in": "query",
"required": true "required": true
@@ -36,6 +37,7 @@
{ {
"type": "integer", "type": "integer",
"default": 20, "default": 20,
"example": 20,
"name": "limit", "name": "limit",
"in": "query", "in": "query",
"required": true "required": true
@@ -67,9 +69,7 @@
"required": [ "required": [
"id", "id",
"consumerId", "consumerId",
"consumerName",
"playerId", "playerId",
"playerName",
"service", "service",
"status", "status",
"totalPrice", "totalPrice",
@@ -85,9 +85,6 @@
"consumerId": { "consumerId": {
"type": "integer" "type": "integer"
}, },
"consumerName": {
"type": "string"
},
"createdAt": { "createdAt": {
"type": "string" "type": "string"
}, },
@@ -100,9 +97,6 @@
"playerId": { "playerId": {
"type": "string" "type": "string"
}, },
"playerName": {
"type": "string"
},
"service": { "service": {
"type": "object", "type": "object",
"required": [ "required": [
@@ -155,9 +149,6 @@
"shopId": { "shopId": {
"type": "integer" "type": "integer"
}, },
"shopName": {
"type": "string"
},
"status": { "status": {
"type": "string" "type": "string"
}, },
@@ -249,9 +240,7 @@
"required": [ "required": [
"id", "id",
"consumerId", "consumerId",
"consumerName",
"playerId", "playerId",
"playerName",
"service", "service",
"status", "status",
"totalPrice", "totalPrice",
@@ -267,9 +256,6 @@
"consumerId": { "consumerId": {
"type": "integer" "type": "integer"
}, },
"consumerName": {
"type": "string"
},
"createdAt": { "createdAt": {
"type": "string" "type": "string"
}, },
@@ -282,9 +268,6 @@
"playerId": { "playerId": {
"type": "string" "type": "string"
}, },
"playerName": {
"type": "string"
},
"service": { "service": {
"type": "object", "type": "object",
"required": [ "required": [
@@ -337,9 +320,6 @@
"shopId": { "shopId": {
"type": "integer" "type": "integer"
}, },
"shopName": {
"type": "string"
},
"status": { "status": {
"type": "string" "type": "string"
}, },
@@ -413,9 +393,7 @@
"required": [ "required": [
"id", "id",
"consumerId", "consumerId",
"consumerName",
"playerId", "playerId",
"playerName",
"service", "service",
"status", "status",
"totalPrice", "totalPrice",
@@ -431,9 +409,6 @@
"consumerId": { "consumerId": {
"type": "integer" "type": "integer"
}, },
"consumerName": {
"type": "string"
},
"createdAt": { "createdAt": {
"type": "string" "type": "string"
}, },
@@ -446,9 +421,6 @@
"playerId": { "playerId": {
"type": "string" "type": "string"
}, },
"playerName": {
"type": "string"
},
"service": { "service": {
"type": "object", "type": "object",
"required": [ "required": [
@@ -501,9 +473,6 @@
"shopId": { "shopId": {
"type": "integer" "type": "integer"
}, },
"shopName": {
"type": "string"
},
"status": { "status": {
"type": "string" "type": "string"
}, },
@@ -551,9 +520,6 @@
"consumerId": { "consumerId": {
"type": "integer" "type": "integer"
}, },
"consumerName": {
"type": "string"
},
"createdAt": { "createdAt": {
"type": "string" "type": "string"
}, },
@@ -566,9 +532,6 @@
"playerId": { "playerId": {
"type": "string" "type": "string"
}, },
"playerName": {
"type": "string"
},
"service": { "service": {
"type": "object", "type": "object",
"required": [ "required": [
@@ -621,9 +584,6 @@
"shopId": { "shopId": {
"type": "integer" "type": "integer"
}, },
"shopName": {
"type": "string"
},
"status": { "status": {
"type": "string" "type": "string"
}, },
@@ -795,9 +755,7 @@
"required": [ "required": [
"id", "id",
"consumerId", "consumerId",
"consumerName",
"playerId", "playerId",
"playerName",
"service", "service",
"status", "status",
"totalPrice", "totalPrice",
@@ -813,9 +771,6 @@
"consumerId": { "consumerId": {
"type": "integer" "type": "integer"
}, },
"consumerName": {
"type": "string"
},
"createdAt": { "createdAt": {
"type": "string" "type": "string"
}, },
@@ -828,9 +783,6 @@
"playerId": { "playerId": {
"type": "string" "type": "string"
}, },
"playerName": {
"type": "string"
},
"service": { "service": {
"type": "object", "type": "object",
"required": [ "required": [
@@ -883,9 +835,6 @@
"shopId": { "shopId": {
"type": "integer" "type": "integer"
}, },
"shopName": {
"type": "string"
},
"status": { "status": {
"type": "string" "type": "string"
}, },
@@ -932,9 +881,9 @@
} }
} }
}, },
"x-date": "2026-03-27 17:39:38", "x-date": "2026-04-22 22:30:23",
"x-description": "This is a goctl generated swagger file.", "x-description": "This is a goctl generated swagger file.",
"x-github": "https://github.com/zeromicro/go-zero", "x-github": "https://github.com/zeromicro/go-zero",
"x-go-zero-doc": "https://go-zero.dev/", "x-go-zero-doc": "https://go-zero.dev/",
"x-goctl-version": "1.9.2" "x-goctl-version": "1.10.1"
} }
desc/api/docs/player-api.json
+16 -20
View File
@@ -29,6 +29,7 @@
{ {
"type": "integer", "type": "integer",
"default": 0, "default": 0,
"example": 0,
"name": "offset", "name": "offset",
"in": "query", "in": "query",
"required": true "required": true
@@ -36,6 +37,7 @@
{ {
"type": "integer", "type": "integer",
"default": 20, "default": 20,
"example": 20,
"name": "limit", "name": "limit",
"in": "query", "in": "query",
"required": true "required": true
@@ -72,6 +74,7 @@
"status", "status",
"games", "games",
"services", "services",
"gender",
"tags" "tags"
], ],
"properties": { "properties": {
@@ -84,6 +87,9 @@
"type": "string" "type": "string"
} }
}, },
"gender": {
"type": "boolean"
},
"id": { "id": {
"type": "integer" "type": "integer"
}, },
@@ -95,7 +101,6 @@
"items": { "items": {
"type": "object", "type": "object",
"required": [ "required": [
"id",
"playerId", "playerId",
"gameId", "gameId",
"gameName", "gameName",
@@ -243,7 +248,7 @@
"/api/v1/players/me": { "/api/v1/players/me": {
"post": { "post": {
"consumes": [ "consumes": [
"application/json" "application/x-www-form-urlencoded"
], ],
"produces": [ "produces": [
"application/json" "application/json"
@@ -253,16 +258,6 @@
], ],
"summary": "初始化当前用户的打手资料", "summary": "初始化当前用户的打手资料",
"operationId": "playerInitPlayer", "operationId": "playerInitPlayer",
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"type": "object"
}
}
],
"responses": { "responses": {
"200": { "200": {
"description": "", "description": "",
@@ -292,7 +287,6 @@
"items": { "items": {
"type": "object", "type": "object",
"required": [ "required": [
"id",
"playerId", "playerId",
"gameId", "gameId",
"gameName", "gameName",
@@ -489,6 +483,9 @@
"type": "string" "type": "string"
} }
}, },
"gender": {
"type": "boolean"
},
"id": { "id": {
"type": "integer" "type": "integer"
}, },
@@ -500,7 +497,6 @@
"items": { "items": {
"type": "object", "type": "object",
"required": [ "required": [
"id",
"playerId", "playerId",
"gameId", "gameId",
"gameName", "gameName",
@@ -637,6 +633,7 @@
{ {
"type": "integer", "type": "integer",
"default": 0, "default": 0,
"example": 0,
"name": "offset", "name": "offset",
"in": "query", "in": "query",
"required": true "required": true
@@ -644,6 +641,7 @@
{ {
"type": "integer", "type": "integer",
"default": 20, "default": 20,
"example": 20,
"name": "limit", "name": "limit",
"in": "query", "in": "query",
"required": true "required": true
@@ -666,7 +664,6 @@
"items": { "items": {
"type": "object", "type": "object",
"required": [ "required": [
"id",
"playerId", "playerId",
"gameId", "gameId",
"gameName", "gameName",
@@ -752,6 +749,7 @@
{ {
"type": "integer", "type": "integer",
"default": 0, "default": 0,
"example": 0,
"name": "offset", "name": "offset",
"in": "query", "in": "query",
"required": true "required": true
@@ -759,6 +757,7 @@
{ {
"type": "integer", "type": "integer",
"default": 20, "default": 20,
"example": 20,
"name": "limit", "name": "limit",
"in": "query", "in": "query",
"required": true "required": true
@@ -775,7 +774,6 @@
"items": { "items": {
"type": "object", "type": "object",
"required": [ "required": [
"id",
"playerId", "playerId",
"gameId", "gameId",
"gameName", "gameName",
@@ -866,7 +864,6 @@
"schema": { "schema": {
"type": "object", "type": "object",
"required": [ "required": [
"gameId",
"price", "price",
"unit" "unit"
], ],
@@ -1032,7 +1029,6 @@
"schema": { "schema": {
"type": "object", "type": "object",
"required": [ "required": [
"gameId",
"availability" "availability"
], ],
"properties": { "properties": {
@@ -1139,9 +1135,9 @@
} }
} }
}, },
"x-date": "2026-03-29 23:48:43", "x-date": "2026-04-22 22:30:24",
"x-description": "This is a goctl generated swagger file.", "x-description": "This is a goctl generated swagger file.",
"x-github": "https://github.com/zeromicro/go-zero", "x-github": "https://github.com/zeromicro/go-zero",
"x-go-zero-doc": "https://go-zero.dev/", "x-go-zero-doc": "https://go-zero.dev/",
"x-goctl-version": "1.9.2" "x-goctl-version": "1.10.1"
} }
desc/api/docs/shop-api.json
+39 -4
View File
@@ -28,6 +28,7 @@
{ {
"type": "integer", "type": "integer",
"default": 0, "default": 0,
"example": 0,
"name": "offset", "name": "offset",
"in": "query", "in": "query",
"required": true "required": true
@@ -35,6 +36,7 @@
{ {
"type": "integer", "type": "integer",
"default": 20, "default": 20,
"example": 20,
"name": "limit", "name": "limit",
"in": "query", "in": "query",
"required": true "required": true
@@ -604,7 +606,7 @@
}, },
"put": { "put": {
"consumes": [ "consumes": [
"application/x-www-form-urlencoded" "application/json"
], ],
"produces": [ "produces": [
"application/json" "application/json"
@@ -620,6 +622,37 @@
"name": "id", "name": "id",
"in": "path", "in": "path",
"required": true "required": true
},
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"type": "object",
"properties": {
"allowIndependentOrders": {
"type": "boolean"
},
"allowMultiShop": {
"type": "boolean"
},
"commissionType": {
"type": "string"
},
"commissionValue": {
"type": "string"
},
"description": {
"type": "string"
},
"dispatchMode": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
} }
], ],
"responses": { "responses": {
@@ -973,7 +1006,9 @@
"sections" "sections"
], ],
"properties": { "properties": {
"sections": {} "sections": {
"type": "string"
}
} }
} }
} }
@@ -1105,9 +1140,9 @@
} }
} }
}, },
"x-date": "2026-03-18 18:48:06", "x-date": "2026-04-22 22:30:24",
"x-description": "This is a goctl generated swagger file.", "x-description": "This is a goctl generated swagger file.",
"x-github": "https://github.com/zeromicro/go-zero", "x-github": "https://github.com/zeromicro/go-zero",
"x-go-zero-doc": "https://go-zero.dev/", "x-go-zero-doc": "https://go-zero.dev/",
"x-goctl-version": "1.9.2" "x-goctl-version": "1.10.1"
} }
desc/api/docs/user-api.json → desc/api/docs/users-api.json
+36 -58
View File
@@ -29,6 +29,7 @@
{ {
"type": "integer", "type": "integer",
"default": 1, "default": 1,
"example": 1,
"name": "page", "name": "page",
"in": "query", "in": "query",
"required": true "required": true
@@ -36,6 +37,7 @@
{ {
"type": "integer", "type": "integer",
"default": 20, "default": 20,
"example": 20,
"name": "size", "name": "size",
"in": "query", "in": "query",
"required": true "required": true
@@ -208,51 +210,6 @@
} }
} }
}, },
"/api/v1/auth/forgot-password": {
"post": {
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"schemes": [
"https"
],
"summary": "忘记密码-发送验证码",
"operationId": "authForgotPassword",
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"type": "object",
"required": [
"phone",
"email"
],
"properties": {
"email": {
"type": "string"
},
"phone": {
"type": "string"
}
}
}
}
],
"responses": {
"200": {
"description": "",
"schema": {
"type": "object"
}
}
}
}
},
"/api/v1/auth/login": { "/api/v1/auth/login": {
"post": { "post": {
"consumes": [ "consumes": [
@@ -328,7 +285,7 @@
"type": "string" "type": "string"
}, },
"id": { "id": {
"type": "integer" "type": "string"
}, },
"nickname": { "nickname": {
"type": "string" "type": "string"
@@ -467,7 +424,7 @@
"type": "string" "type": "string"
}, },
"id": { "id": {
"type": "integer" "type": "string"
}, },
"nickname": { "nickname": {
"type": "string" "type": "string"
@@ -525,7 +482,6 @@
"schema": { "schema": {
"type": "object", "type": "object",
"required": [ "required": [
"phone",
"email", "email",
"vcode", "vcode",
"newPassword" "newPassword"
@@ -584,7 +540,7 @@
"type": "string" "type": "string"
}, },
"id": { "id": {
"type": "integer" "type": "string"
}, },
"nickname": { "nickname": {
"type": "string" "type": "string"
@@ -668,7 +624,7 @@
"type": "string" "type": "string"
}, },
"id": { "id": {
"type": "integer" "type": "string"
}, },
"nickname": { "nickname": {
"type": "string" "type": "string"
@@ -937,8 +893,30 @@
"materials": { "materials": {
"description": "证明材料键值对 {\"idCardFront\": \"http...\", \"license\": \"http...\"}", "description": "证明材料键值对 {\"idCardFront\": \"http...\", \"license\": \"http...\"}",
"type": "object", "type": "object",
"additionalProperties": { "required": [
"type": "string" "idCardFront",
"idCardBack"
],
"properties": {
"gameScreenshots": {
"description": "游戏截图URL列表",
"type": "array",
"items": {
"type": "string"
}
},
"idCardBack": {
"description": "身份证反面照片URL",
"type": "string"
},
"idCardFront": {
"description": "身份证正面照片URL",
"type": "string"
},
"voiceDemo": {
"description": "语音认证示例URL",
"type": "string"
}
} }
}, },
"role": { "role": {
@@ -971,7 +949,7 @@
"operationId": "userGetUserInfo", "operationId": "userGetUserInfo",
"parameters": [ "parameters": [
{ {
"type": "integer", "type": "string",
"name": "id", "name": "id",
"in": "path", "in": "path",
"required": true "required": true
@@ -994,7 +972,7 @@
"type": "string" "type": "string"
}, },
"id": { "id": {
"type": "integer" "type": "string"
}, },
"nickname": { "nickname": {
"type": "string" "type": "string"
@@ -1044,7 +1022,7 @@
"operationId": "userFollowUser", "operationId": "userFollowUser",
"parameters": [ "parameters": [
{ {
"type": "integer", "type": "string",
"name": "id", "name": "id",
"in": "path", "in": "path",
"required": true "required": true
@@ -1073,7 +1051,7 @@
"operationId": "userUnfollowUser", "operationId": "userUnfollowUser",
"parameters": [ "parameters": [
{ {
"type": "integer", "type": "string",
"name": "id", "name": "id",
"in": "path", "in": "path",
"required": true "required": true
@@ -1090,9 +1068,9 @@
} }
} }
}, },
"x-date": "2026-03-18 18:48:12", "x-date": "2026-04-22 22:30:22",
"x-description": "This is a goctl generated swagger file.", "x-description": "This is a goctl generated swagger file.",
"x-github": "https://github.com/zeromicro/go-zero", "x-github": "https://github.com/zeromicro/go-zero",
"x-go-zero-doc": "https://go-zero.dev/", "x-go-zero-doc": "https://go-zero.dev/",
"x-goctl-version": "1.9.2" "x-goctl-version": "1.10.1"
} }
desc/api/docs/wallet-api.json
+4 -2
View File
@@ -102,6 +102,7 @@
{ {
"type": "integer", "type": "integer",
"default": 0, "default": 0,
"example": 0,
"name": "offset", "name": "offset",
"in": "query", "in": "query",
"required": true "required": true
@@ -109,6 +110,7 @@
{ {
"type": "integer", "type": "integer",
"default": 20, "default": 20,
"example": 20,
"name": "limit", "name": "limit",
"in": "query", "in": "query",
"required": true "required": true
@@ -224,9 +226,9 @@
} }
} }
}, },
"x-date": "2026-03-26 17:02:28", "x-date": "2026-04-22 22:30:25",
"x-description": "This is a goctl generated swagger file.", "x-description": "This is a goctl generated swagger file.",
"x-github": "https://github.com/zeromicro/go-zero", "x-github": "https://github.com/zeromicro/go-zero",
"x-go-zero-doc": "https://go-zero.dev/", "x-go-zero-doc": "https://go-zero.dev/",
"x-goctl-version": "1.9.2" "x-goctl-version": "1.10.1"
} }