From 6f2773273e68ecf4670331f761a0a5ce2bc7b222 Mon Sep 17 00:00:00 2001 From: zetaloop Date: Wed, 22 Apr 2026 22:31:25 +0800 Subject: [PATCH] chore: regenerate swagger docs for all API services --- desc/api/docs/community-api.json | 1067 +++++++++++++++++ desc/api/docs/email-api.json | 121 ++ desc/api/docs/game-api.json | 9 +- .../{os-api.json => objectstory-api.json} | 10 +- desc/api/docs/order-api.json | 59 +- desc/api/docs/player-api.json | 38 +- desc/api/docs/shop-api.json | 43 +- .../docs/{user-api.json => users-api.json} | 94 +- desc/api/docs/wallet-api.json | 6 +- 9 files changed, 1297 insertions(+), 150 deletions(-) create mode 100644 desc/api/docs/community-api.json create mode 100644 desc/api/docs/email-api.json rename desc/api/docs/{os-api.json => objectstory-api.json} (92%) rename desc/api/docs/{user-api.json => users-api.json} (95%) diff --git a/desc/api/docs/community-api.json b/desc/api/docs/community-api.json new file mode 100644 index 0000000..1101cb1 --- /dev/null +++ b/desc/api/docs/community-api.json @@ -0,0 +1,1067 @@ +{ + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "schemes": [ + "https" + ], + "swagger": "2.0", + "info": { + "version": "1.0" + }, + "basePath": "/", + "paths": { + "/api/v1/comments/{id}/like": { + "post": { + "consumes": [ + "application/x-www-form-urlencoded" + ], + "produces": [ + "application/json" + ], + "schemes": [ + "https" + ], + "summary": "点赞评论", + "operationId": "communityLikeComment", + "parameters": [ + { + "type": "integer", + "name": "id", + "in": "path", + "required": true + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "type": "object" + } + } + } + }, + "delete": { + "consumes": [ + "application/x-www-form-urlencoded" + ], + "produces": [ + "application/json" + ], + "schemes": [ + "https" + ], + "summary": "取消点赞评论", + "operationId": "communityUnlikeComment", + "parameters": [ + { + "type": "integer", + "name": "id", + "in": "path", + "required": true + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "type": "object" + } + } + } + } + }, + "/api/v1/posts": { + "get": { + "produces": [ + "application/json" + ], + "schemes": [ + "https" + ], + "summary": "获取帖子列表", + "operationId": "communityListPosts", + "parameters": [ + { + "type": "integer", + "default": 0, + "example": 0, + "name": "offset", + "in": "query", + "required": true + }, + { + "type": "integer", + "default": 20, + "example": 20, + "name": "limit", + "in": "query", + "required": true + }, + { + "type": "string", + "name": "tags", + "in": "query", + "allowEmptyValue": true + }, + { + "type": "string", + "name": "sortBy", + "in": "query", + "allowEmptyValue": true + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "type": "object", + "properties": { + "items": { + "type": "array", + "items": { + "type": "object", + "required": [ + "id", + "title", + "content", + "images", + "tags", + "likeCount", + "commentCount", + "liked", + "author", + "createdAt" + ], + "properties": { + "author": { + "type": "object", + "required": [ + "id", + "username", + "nickname", + "avatar", + "role", + "verifiedRoles", + "verificationStatus", + "createdAt" + ], + "properties": { + "avatar": { + "type": "string" + }, + "bio": { + "type": "string" + }, + "createdAt": { + "type": "string" + }, + "id": { + "type": "string" + }, + "nickname": { + "type": "string" + }, + "phone": { + "type": "string" + }, + "role": { + "description": "consumer, player, owner, admin", + "type": "string" + }, + "username": { + "type": "string" + }, + "verificationStatus": { + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "verifiedRoles": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "commentCount": { + "type": "integer" + }, + "content": { + "type": "string" + }, + "createdAt": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "images": { + "type": "array", + "items": { + "type": "string" + } + }, + "likeCount": { + "type": "integer" + }, + "liked": { + "type": "boolean" + }, + "tags": { + "type": "array", + "items": { + "type": "string" + } + }, + "title": { + "type": "string" + } + } + } + }, + "meta": { + "type": "object", + "required": [ + "total", + "offset", + "limit" + ], + "properties": { + "limit": { + "type": "integer" + }, + "offset": { + "type": "integer" + }, + "total": { + "type": "integer" + } + } + } + } + } + } + } + }, + "post": { + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "schemes": [ + "https" + ], + "summary": "发布帖子", + "operationId": "communityCreatePost", + "parameters": [ + { + "name": "body", + "in": "body", + "required": true, + "schema": { + "type": "object", + "required": [ + "title", + "content", + "images", + "tags" + ], + "properties": { + "content": { + "type": "string" + }, + "images": { + "type": "array", + "items": { + "type": "string" + } + }, + "linkedOrderId": { + "type": "string" + }, + "tags": { + "type": "array", + "items": { + "type": "string" + } + }, + "title": { + "type": "string" + } + } + } + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "type": "object", + "properties": { + "author": { + "type": "object", + "required": [ + "id", + "username", + "nickname", + "avatar", + "role", + "verifiedRoles", + "verificationStatus", + "createdAt" + ], + "properties": { + "avatar": { + "type": "string" + }, + "bio": { + "type": "string" + }, + "createdAt": { + "type": "string" + }, + "id": { + "type": "string" + }, + "nickname": { + "type": "string" + }, + "phone": { + "type": "string" + }, + "role": { + "description": "consumer, player, owner, admin", + "type": "string" + }, + "username": { + "type": "string" + }, + "verificationStatus": { + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "verifiedRoles": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "commentCount": { + "type": "integer" + }, + "content": { + "type": "string" + }, + "createdAt": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "images": { + "type": "array", + "items": { + "type": "string" + } + }, + "likeCount": { + "type": "integer" + }, + "liked": { + "type": "boolean" + }, + "tags": { + "type": "array", + "items": { + "type": "string" + } + }, + "title": { + "type": "string" + } + } + } + } + } + } + }, + "/api/v1/posts/{id}": { + "get": { + "produces": [ + "application/json" + ], + "schemes": [ + "https" + ], + "summary": "获取帖子详情", + "operationId": "communityGetPost", + "parameters": [ + { + "type": "integer", + "name": "id", + "in": "path", + "required": true + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "type": "object", + "properties": { + "author": { + "type": "object", + "required": [ + "id", + "username", + "nickname", + "avatar", + "role", + "verifiedRoles", + "verificationStatus", + "createdAt" + ], + "properties": { + "avatar": { + "type": "string" + }, + "bio": { + "type": "string" + }, + "createdAt": { + "type": "string" + }, + "id": { + "type": "string" + }, + "nickname": { + "type": "string" + }, + "phone": { + "type": "string" + }, + "role": { + "description": "consumer, player, owner, admin", + "type": "string" + }, + "username": { + "type": "string" + }, + "verificationStatus": { + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "verifiedRoles": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "commentCount": { + "type": "integer" + }, + "content": { + "type": "string" + }, + "createdAt": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "images": { + "type": "array", + "items": { + "type": "string" + } + }, + "likeCount": { + "type": "integer" + }, + "liked": { + "type": "boolean" + }, + "tags": { + "type": "array", + "items": { + "type": "string" + } + }, + "title": { + "type": "string" + } + } + } + } + } + } + }, + "/api/v1/posts/{id}/comments": { + "get": { + "produces": [ + "application/json" + ], + "schemes": [ + "https" + ], + "summary": "获取帖子评论", + "operationId": "communityListComments", + "parameters": [ + { + "type": "integer", + "name": "id", + "in": "path", + "required": true + }, + { + "type": "integer", + "default": 0, + "example": 0, + "name": "offset", + "in": "query", + "required": true + }, + { + "type": "integer", + "default": 20, + "example": 20, + "name": "limit", + "in": "query", + "required": true + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "type": "object", + "properties": { + "items": { + "type": "array", + "items": { + "type": "object", + "required": [ + "id", + "content", + "author", + "likeCount", + "liked", + "createdAt" + ], + "properties": { + "author": { + "type": "object", + "required": [ + "id", + "username", + "nickname", + "avatar", + "role", + "verifiedRoles", + "verificationStatus", + "createdAt" + ], + "properties": { + "avatar": { + "type": "string" + }, + "bio": { + "type": "string" + }, + "createdAt": { + "type": "string" + }, + "id": { + "type": "string" + }, + "nickname": { + "type": "string" + }, + "phone": { + "type": "string" + }, + "role": { + "description": "consumer, player, owner, admin", + "type": "string" + }, + "username": { + "type": "string" + }, + "verificationStatus": { + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "verifiedRoles": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "content": { + "type": "string" + }, + "createdAt": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "likeCount": { + "type": "integer" + }, + "liked": { + "type": "boolean" + } + } + } + }, + "meta": { + "type": "object", + "required": [ + "total", + "offset", + "limit" + ], + "properties": { + "limit": { + "type": "integer" + }, + "offset": { + "type": "integer" + }, + "total": { + "type": "integer" + } + } + } + } + } + } + } + }, + "post": { + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "schemes": [ + "https" + ], + "summary": "发表评论", + "operationId": "communityCreateComment", + "parameters": [ + { + "name": "body", + "in": "body", + "required": true, + "schema": { + "type": "object", + "required": [ + "content" + ], + "properties": { + "content": { + "type": "string" + } + } + } + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "type": "object", + "properties": { + "author": { + "type": "object", + "required": [ + "id", + "username", + "nickname", + "avatar", + "role", + "verifiedRoles", + "verificationStatus", + "createdAt" + ], + "properties": { + "avatar": { + "type": "string" + }, + "bio": { + "type": "string" + }, + "createdAt": { + "type": "string" + }, + "id": { + "type": "string" + }, + "nickname": { + "type": "string" + }, + "phone": { + "type": "string" + }, + "role": { + "description": "consumer, player, owner, admin", + "type": "string" + }, + "username": { + "type": "string" + }, + "verificationStatus": { + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "verifiedRoles": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "content": { + "type": "string" + }, + "createdAt": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "likeCount": { + "type": "integer" + }, + "liked": { + "type": "boolean" + } + } + } + } + } + } + }, + "/api/v1/posts/{id}/like": { + "post": { + "consumes": [ + "application/x-www-form-urlencoded" + ], + "produces": [ + "application/json" + ], + "schemes": [ + "https" + ], + "summary": "点赞帖子", + "operationId": "communityLikePost", + "parameters": [ + { + "type": "integer", + "name": "id", + "in": "path", + "required": true + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "type": "object" + } + } + } + }, + "delete": { + "consumes": [ + "application/x-www-form-urlencoded" + ], + "produces": [ + "application/json" + ], + "schemes": [ + "https" + ], + "summary": "取消点赞帖子", + "operationId": "communityUnlikePost", + "parameters": [ + { + "type": "integer", + "name": "id", + "in": "path", + "required": true + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "type": "object" + } + } + } + } + }, + "/api/v1/posts/{id}/pin": { + "post": { + "consumes": [ + "application/x-www-form-urlencoded" + ], + "produces": [ + "application/json" + ], + "schemes": [ + "https" + ], + "summary": "置顶帖子", + "operationId": "communityPinPost", + "parameters": [ + { + "type": "integer", + "name": "id", + "in": "path", + "required": true + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "type": "object" + } + } + } + }, + "delete": { + "consumes": [ + "application/x-www-form-urlencoded" + ], + "produces": [ + "application/json" + ], + "schemes": [ + "https" + ], + "summary": "取消置顶", + "operationId": "communityUnpinPost", + "parameters": [ + { + "type": "integer", + "name": "id", + "in": "path", + "required": true + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "type": "object" + } + } + } + } + }, + "/api/v1/users/{id}/posts": { + "get": { + "produces": [ + "application/json" + ], + "schemes": [ + "https" + ], + "summary": "获取用户帖子", + "operationId": "communityListUserPosts", + "parameters": [ + { + "type": "integer", + "name": "id", + "in": "path", + "required": true + }, + { + "type": "integer", + "default": 0, + "example": 0, + "name": "offset", + "in": "query", + "required": true + }, + { + "type": "integer", + "default": 20, + "example": 20, + "name": "limit", + "in": "query", + "required": true + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "type": "object", + "properties": { + "items": { + "type": "array", + "items": { + "type": "object", + "required": [ + "id", + "title", + "content", + "images", + "tags", + "likeCount", + "commentCount", + "liked", + "author", + "createdAt" + ], + "properties": { + "author": { + "type": "object", + "required": [ + "id", + "username", + "nickname", + "avatar", + "role", + "verifiedRoles", + "verificationStatus", + "createdAt" + ], + "properties": { + "avatar": { + "type": "string" + }, + "bio": { + "type": "string" + }, + "createdAt": { + "type": "string" + }, + "id": { + "type": "string" + }, + "nickname": { + "type": "string" + }, + "phone": { + "type": "string" + }, + "role": { + "description": "consumer, player, owner, admin", + "type": "string" + }, + "username": { + "type": "string" + }, + "verificationStatus": { + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "verifiedRoles": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "commentCount": { + "type": "integer" + }, + "content": { + "type": "string" + }, + "createdAt": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "images": { + "type": "array", + "items": { + "type": "string" + } + }, + "likeCount": { + "type": "integer" + }, + "liked": { + "type": "boolean" + }, + "tags": { + "type": "array", + "items": { + "type": "string" + } + }, + "title": { + "type": "string" + } + } + } + }, + "meta": { + "type": "object", + "required": [ + "total", + "offset", + "limit" + ], + "properties": { + "limit": { + "type": "integer" + }, + "offset": { + "type": "integer" + }, + "total": { + "type": "integer" + } + } + } + } + } + } + } + } + } + }, + "x-date": "2026-04-22 22:30:25", + "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" +} \ No newline at end of file diff --git a/desc/api/docs/email-api.json b/desc/api/docs/email-api.json new file mode 100644 index 0000000..5a66e5b --- /dev/null +++ b/desc/api/docs/email-api.json @@ -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" +} \ No newline at end of file diff --git a/desc/api/docs/game-api.json b/desc/api/docs/game-api.json index 08d2d7b..6c1e01d 100644 --- a/desc/api/docs/game-api.json +++ b/desc/api/docs/game-api.json @@ -10,7 +10,6 @@ ], "swagger": "2.0", "info": { - "title": "game-api", "version": "1.0" }, "basePath": "/", @@ -29,6 +28,7 @@ { "type": "integer", "default": 0, + "example": 0, "name": "offset", "in": "query", "required": true @@ -36,6 +36,7 @@ { "type": "integer", "default": 20, + "example": 20, "name": "limit", "in": "query", "required": true @@ -52,7 +53,6 @@ "items": { "type": "object", "required": [ - "id", "name", "icon", "category" @@ -117,7 +117,6 @@ "schema": { "type": "object", "required": [ - "id", "name", "icon", "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-github": "https://github.com/zeromicro/go-zero", "x-go-zero-doc": "https://go-zero.dev/", - "x-goctl-version": "1.9.2" + "x-goctl-version": "1.10.1" } \ No newline at end of file diff --git a/desc/api/docs/os-api.json b/desc/api/docs/objectstory-api.json similarity index 92% rename from desc/api/docs/os-api.json rename to desc/api/docs/objectstory-api.json index fa90b88..0145d04 100644 --- a/desc/api/docs/os-api.json +++ b/desc/api/docs/objectstory-api.json @@ -15,7 +15,7 @@ }, "basePath": "/", "paths": { - "/api/v1/files/{fileId}": { + "/api/v1/files": { "get": { "produces": [ "application/json" @@ -28,8 +28,8 @@ "parameters": [ { "type": "string", - "name": "fileId", - "in": "path", + "name": "key", + "in": "query", "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-github": "https://github.com/zeromicro/go-zero", "x-go-zero-doc": "https://go-zero.dev/", - "x-goctl-version": "1.9.2" + "x-goctl-version": "1.10.1" } \ No newline at end of file diff --git a/desc/api/docs/order-api.json b/desc/api/docs/order-api.json index 04b6aef..13dbc5b 100644 --- a/desc/api/docs/order-api.json +++ b/desc/api/docs/order-api.json @@ -29,6 +29,7 @@ { "type": "integer", "default": 0, + "example": 0, "name": "offset", "in": "query", "required": true @@ -36,6 +37,7 @@ { "type": "integer", "default": 20, + "example": 20, "name": "limit", "in": "query", "required": true @@ -67,9 +69,7 @@ "required": [ "id", "consumerId", - "consumerName", "playerId", - "playerName", "service", "status", "totalPrice", @@ -85,9 +85,6 @@ "consumerId": { "type": "integer" }, - "consumerName": { - "type": "string" - }, "createdAt": { "type": "string" }, @@ -100,9 +97,6 @@ "playerId": { "type": "string" }, - "playerName": { - "type": "string" - }, "service": { "type": "object", "required": [ @@ -155,9 +149,6 @@ "shopId": { "type": "integer" }, - "shopName": { - "type": "string" - }, "status": { "type": "string" }, @@ -249,9 +240,7 @@ "required": [ "id", "consumerId", - "consumerName", "playerId", - "playerName", "service", "status", "totalPrice", @@ -267,9 +256,6 @@ "consumerId": { "type": "integer" }, - "consumerName": { - "type": "string" - }, "createdAt": { "type": "string" }, @@ -282,9 +268,6 @@ "playerId": { "type": "string" }, - "playerName": { - "type": "string" - }, "service": { "type": "object", "required": [ @@ -337,9 +320,6 @@ "shopId": { "type": "integer" }, - "shopName": { - "type": "string" - }, "status": { "type": "string" }, @@ -413,9 +393,7 @@ "required": [ "id", "consumerId", - "consumerName", "playerId", - "playerName", "service", "status", "totalPrice", @@ -431,9 +409,6 @@ "consumerId": { "type": "integer" }, - "consumerName": { - "type": "string" - }, "createdAt": { "type": "string" }, @@ -446,9 +421,6 @@ "playerId": { "type": "string" }, - "playerName": { - "type": "string" - }, "service": { "type": "object", "required": [ @@ -501,9 +473,6 @@ "shopId": { "type": "integer" }, - "shopName": { - "type": "string" - }, "status": { "type": "string" }, @@ -551,9 +520,6 @@ "consumerId": { "type": "integer" }, - "consumerName": { - "type": "string" - }, "createdAt": { "type": "string" }, @@ -566,9 +532,6 @@ "playerId": { "type": "string" }, - "playerName": { - "type": "string" - }, "service": { "type": "object", "required": [ @@ -621,9 +584,6 @@ "shopId": { "type": "integer" }, - "shopName": { - "type": "string" - }, "status": { "type": "string" }, @@ -795,9 +755,7 @@ "required": [ "id", "consumerId", - "consumerName", "playerId", - "playerName", "service", "status", "totalPrice", @@ -813,9 +771,6 @@ "consumerId": { "type": "integer" }, - "consumerName": { - "type": "string" - }, "createdAt": { "type": "string" }, @@ -828,9 +783,6 @@ "playerId": { "type": "string" }, - "playerName": { - "type": "string" - }, "service": { "type": "object", "required": [ @@ -883,9 +835,6 @@ "shopId": { "type": "integer" }, - "shopName": { - "type": "string" - }, "status": { "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-github": "https://github.com/zeromicro/go-zero", "x-go-zero-doc": "https://go-zero.dev/", - "x-goctl-version": "1.9.2" + "x-goctl-version": "1.10.1" } \ No newline at end of file diff --git a/desc/api/docs/player-api.json b/desc/api/docs/player-api.json index 8d7bcaf..a611e74 100644 --- a/desc/api/docs/player-api.json +++ b/desc/api/docs/player-api.json @@ -29,6 +29,7 @@ { "type": "integer", "default": 0, + "example": 0, "name": "offset", "in": "query", "required": true @@ -36,6 +37,7 @@ { "type": "integer", "default": 20, + "example": 20, "name": "limit", "in": "query", "required": true @@ -72,6 +74,7 @@ "status", "games", "services", + "gender", "tags" ], "properties": { @@ -84,6 +87,9 @@ "type": "string" } }, + "gender": { + "type": "boolean" + }, "id": { "type": "integer" }, @@ -95,7 +101,6 @@ "items": { "type": "object", "required": [ - "id", "playerId", "gameId", "gameName", @@ -243,7 +248,7 @@ "/api/v1/players/me": { "post": { "consumes": [ - "application/json" + "application/x-www-form-urlencoded" ], "produces": [ "application/json" @@ -253,16 +258,6 @@ ], "summary": "初始化当前用户的打手资料", "operationId": "playerInitPlayer", - "parameters": [ - { - "name": "body", - "in": "body", - "required": true, - "schema": { - "type": "object" - } - } - ], "responses": { "200": { "description": "", @@ -292,7 +287,6 @@ "items": { "type": "object", "required": [ - "id", "playerId", "gameId", "gameName", @@ -489,6 +483,9 @@ "type": "string" } }, + "gender": { + "type": "boolean" + }, "id": { "type": "integer" }, @@ -500,7 +497,6 @@ "items": { "type": "object", "required": [ - "id", "playerId", "gameId", "gameName", @@ -637,6 +633,7 @@ { "type": "integer", "default": 0, + "example": 0, "name": "offset", "in": "query", "required": true @@ -644,6 +641,7 @@ { "type": "integer", "default": 20, + "example": 20, "name": "limit", "in": "query", "required": true @@ -666,7 +664,6 @@ "items": { "type": "object", "required": [ - "id", "playerId", "gameId", "gameName", @@ -752,6 +749,7 @@ { "type": "integer", "default": 0, + "example": 0, "name": "offset", "in": "query", "required": true @@ -759,6 +757,7 @@ { "type": "integer", "default": 20, + "example": 20, "name": "limit", "in": "query", "required": true @@ -775,7 +774,6 @@ "items": { "type": "object", "required": [ - "id", "playerId", "gameId", "gameName", @@ -866,7 +864,6 @@ "schema": { "type": "object", "required": [ - "gameId", "price", "unit" ], @@ -1032,7 +1029,6 @@ "schema": { "type": "object", "required": [ - "gameId", "availability" ], "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-github": "https://github.com/zeromicro/go-zero", "x-go-zero-doc": "https://go-zero.dev/", - "x-goctl-version": "1.9.2" -} + "x-goctl-version": "1.10.1" +} \ No newline at end of file diff --git a/desc/api/docs/shop-api.json b/desc/api/docs/shop-api.json index c31a911..5520ba5 100644 --- a/desc/api/docs/shop-api.json +++ b/desc/api/docs/shop-api.json @@ -28,6 +28,7 @@ { "type": "integer", "default": 0, + "example": 0, "name": "offset", "in": "query", "required": true @@ -35,6 +36,7 @@ { "type": "integer", "default": 20, + "example": 20, "name": "limit", "in": "query", "required": true @@ -604,7 +606,7 @@ }, "put": { "consumes": [ - "application/x-www-form-urlencoded" + "application/json" ], "produces": [ "application/json" @@ -620,6 +622,37 @@ "name": "id", "in": "path", "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": { @@ -973,7 +1006,9 @@ "sections" ], "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-github": "https://github.com/zeromicro/go-zero", "x-go-zero-doc": "https://go-zero.dev/", - "x-goctl-version": "1.9.2" + "x-goctl-version": "1.10.1" } \ No newline at end of file diff --git a/desc/api/docs/user-api.json b/desc/api/docs/users-api.json similarity index 95% rename from desc/api/docs/user-api.json rename to desc/api/docs/users-api.json index 403ed91..be905e5 100644 --- a/desc/api/docs/user-api.json +++ b/desc/api/docs/users-api.json @@ -29,6 +29,7 @@ { "type": "integer", "default": 1, + "example": 1, "name": "page", "in": "query", "required": true @@ -36,6 +37,7 @@ { "type": "integer", "default": 20, + "example": 20, "name": "size", "in": "query", "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": { "post": { "consumes": [ @@ -328,7 +285,7 @@ "type": "string" }, "id": { - "type": "integer" + "type": "string" }, "nickname": { "type": "string" @@ -467,7 +424,7 @@ "type": "string" }, "id": { - "type": "integer" + "type": "string" }, "nickname": { "type": "string" @@ -525,7 +482,6 @@ "schema": { "type": "object", "required": [ - "phone", "email", "vcode", "newPassword" @@ -584,7 +540,7 @@ "type": "string" }, "id": { - "type": "integer" + "type": "string" }, "nickname": { "type": "string" @@ -668,7 +624,7 @@ "type": "string" }, "id": { - "type": "integer" + "type": "string" }, "nickname": { "type": "string" @@ -937,8 +893,30 @@ "materials": { "description": "证明材料键值对 {\"idCardFront\": \"http...\", \"license\": \"http...\"}", "type": "object", - "additionalProperties": { - "type": "string" + "required": [ + "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": { @@ -971,7 +949,7 @@ "operationId": "userGetUserInfo", "parameters": [ { - "type": "integer", + "type": "string", "name": "id", "in": "path", "required": true @@ -994,7 +972,7 @@ "type": "string" }, "id": { - "type": "integer" + "type": "string" }, "nickname": { "type": "string" @@ -1044,7 +1022,7 @@ "operationId": "userFollowUser", "parameters": [ { - "type": "integer", + "type": "string", "name": "id", "in": "path", "required": true @@ -1073,7 +1051,7 @@ "operationId": "userUnfollowUser", "parameters": [ { - "type": "integer", + "type": "string", "name": "id", "in": "path", "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-github": "https://github.com/zeromicro/go-zero", "x-go-zero-doc": "https://go-zero.dev/", - "x-goctl-version": "1.9.2" + "x-goctl-version": "1.10.1" } \ No newline at end of file diff --git a/desc/api/docs/wallet-api.json b/desc/api/docs/wallet-api.json index 656a754..aba34f0 100644 --- a/desc/api/docs/wallet-api.json +++ b/desc/api/docs/wallet-api.json @@ -102,6 +102,7 @@ { "type": "integer", "default": 0, + "example": 0, "name": "offset", "in": "query", "required": true @@ -109,6 +110,7 @@ { "type": "integer", "default": 20, + "example": 20, "name": "limit", "in": "query", "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-github": "https://github.com/zeromicro/go-zero", "x-go-zero-doc": "https://go-zero.dev/", - "x-goctl-version": "1.9.2" + "x-goctl-version": "1.10.1" } \ No newline at end of file