From a3518d20f1d3b08d3ff01add949417652c985c1d Mon Sep 17 00:00:00 2001 From: zetaloop Date: Sun, 3 May 2026 20:58:28 +0800 Subject: [PATCH] =?UTF-8?q?docs:=20=E5=9C=A8=E6=8E=A5=E5=8F=A3=E6=96=87?= =?UTF-8?q?=E6=A1=A3=E8=A1=A5=E5=85=A8=20title=20=E4=B8=8E=20desc=20?= =?UTF-8?q?=E5=B9=B6=E6=A0=87=E6=B3=A8=20ID=20=E5=BA=8F=E5=88=97=E5=8C=96?= =?UTF-8?q?=E5=BD=A2=E5=BC=8F?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- desc/api/community.api | 7 +++++++ desc/api/dispute.api | 7 +++++++ desc/api/docs/community-api.json | 5 +++-- desc/api/docs/dispute-api.json | 5 +++-- desc/api/docs/email-api.json | 3 ++- desc/api/docs/game-api.json | 5 +++-- desc/api/docs/notification-api.json | 5 +++-- desc/api/docs/order-api.json | 2 +- desc/api/docs/player-api.json | 2 +- desc/api/docs/review-api.json | 5 +++-- desc/api/docs/search-api.json | 5 +++-- desc/api/docs/shop-api.json | 5 +++-- desc/api/docs/users-api.json | 2 +- desc/api/docs/wallet-api.json | 2 +- desc/api/email.api | 2 ++ desc/api/game.api | 7 +++++++ desc/api/notification.api | 7 +++++++ desc/api/order.api | 2 +- desc/api/player.api | 2 +- desc/api/review.api | 7 +++++++ desc/api/search.api | 7 +++++++ desc/api/shop.api | 7 +++++++ desc/api/users.api | 2 +- desc/api/wallet.api | 2 +- 24 files changed, 82 insertions(+), 23 deletions(-) diff --git a/desc/api/community.api b/desc/api/community.api index b8018db..31ffbe1 100644 --- a/desc/api/community.api +++ b/desc/api/community.api @@ -2,6 +2,13 @@ syntax = "v1" import "common.api" +info ( + title: "聚玩社区服务" + desc: "处理帖子、评论、点赞等社区互动。ID 字段（int64）以 string 传输" + author: "Asadz" + version: "1.0" +) + type ( PathId { Id int64 `path:"id"` diff --git a/desc/api/dispute.api b/desc/api/dispute.api index d17420e..2f931e5 100644 --- a/desc/api/dispute.api +++ b/desc/api/dispute.api @@ -2,6 +2,13 @@ syntax = "v1" import "common.api" +info ( + title: "聚玩争议服务" + desc: "处理订单争议申诉与仲裁。ID 字段（int64）以 string 传输" + author: "Asadz" + version: "1.0" +) + type ( DisputePathId { Id int64 `path:"id"` diff --git a/desc/api/docs/community-api.json b/desc/api/docs/community-api.json index 8ace6fa..21eba89 100644 --- a/desc/api/docs/community-api.json +++ b/desc/api/docs/community-api.json @@ -1,8 +1,9 @@ { "swagger": "2.0", "info": { - "title": "", - "version": "" + "title": "聚玩社区服务", + "description": "处理帖子、评论、点赞等社区互动。ID 字段（int64）以 string 传输", + "version": "1.0" }, "schemes": [ "http", diff --git a/desc/api/docs/dispute-api.json b/desc/api/docs/dispute-api.json index 0f9caf6..c96d8be 100644 --- a/desc/api/docs/dispute-api.json +++ b/desc/api/docs/dispute-api.json @@ -1,8 +1,9 @@ { "swagger": "2.0", "info": { - "title": "", - "version": "" + "title": "聚玩争议服务", + "description": "处理订单争议申诉与仲裁。ID 字段（int64）以 string 传输", + "version": "1.0" }, "schemes": [ "http", diff --git a/desc/api/docs/email-api.json b/desc/api/docs/email-api.json index e6f8d05..ce8eb8e 100644 --- a/desc/api/docs/email-api.json +++ b/desc/api/docs/email-api.json @@ -1,7 +1,8 @@ { "swagger": "2.0", "info": { - "title": "", + "title": "聚玩邮件服务", + "description": "处理邮件验证码发送与密码找回", "version": "1.0" }, "schemes": [ diff --git a/desc/api/docs/game-api.json b/desc/api/docs/game-api.json index b1f7168..efc8e3f 100644 --- a/desc/api/docs/game-api.json +++ b/desc/api/docs/game-api.json @@ -1,8 +1,9 @@ { "swagger": "2.0", "info": { - "title": "", - "version": "" + "title": "聚玩游戏服务", + "description": "管理游戏目录与分类。ID 字段（int64）以 string 传输", + "version": "1.0" }, "schemes": [ "http", diff --git a/desc/api/docs/notification-api.json b/desc/api/docs/notification-api.json index 80b3312..3ba986c 100644 --- a/desc/api/docs/notification-api.json +++ b/desc/api/docs/notification-api.json @@ -1,8 +1,9 @@ { "swagger": "2.0", "info": { - "title": "", - "version": "" + "title": "聚玩通知服务", + "description": "管理站内消息通知。ID 字段（int64）以 string 传输", + "version": "1.0" }, "schemes": [ "http", diff --git a/desc/api/docs/order-api.json b/desc/api/docs/order-api.json index afe447f..a8e8831 100644 --- a/desc/api/docs/order-api.json +++ b/desc/api/docs/order-api.json @@ -2,7 +2,7 @@ "swagger": "2.0", "info": { "title": "聚玩订单服务", - "description": "处理订单业务", + "description": "处理订单业务。ID 字段（int64）以 string 传输", "version": "1.0" }, "schemes": [ diff --git a/desc/api/docs/player-api.json b/desc/api/docs/player-api.json index 0818af4..029db74 100644 --- a/desc/api/docs/player-api.json +++ b/desc/api/docs/player-api.json @@ -2,7 +2,7 @@ "swagger": "2.0", "info": { "title": "聚玩打手服务", - "description": "聚玩用户服务处理打手信息管理、服务发布及订单相关接口", + "description": "聚玩用户服务处理打手信息管理、服务发布及订单相关接口。ID 字段（int64）以 string 传输", "version": "1.0" }, "schemes": [ diff --git a/desc/api/docs/review-api.json b/desc/api/docs/review-api.json index c22cf25..27214b7 100644 --- a/desc/api/docs/review-api.json +++ b/desc/api/docs/review-api.json @@ -1,8 +1,9 @@ { "swagger": "2.0", "info": { - "title": "", - "version": "" + "title": "聚玩评价服务", + "description": "处理订单评价与评分。ID 字段（int64）以 string 传输", + "version": "1.0" }, "schemes": [ "http", diff --git a/desc/api/docs/search-api.json b/desc/api/docs/search-api.json index 0c37aa7..8a78822 100644 --- a/desc/api/docs/search-api.json +++ b/desc/api/docs/search-api.json @@ -1,8 +1,9 @@ { "swagger": "2.0", "info": { - "title": "", - "version": "" + "title": "聚玩搜索服务", + "description": "内容搜索与首页推荐", + "version": "1.0" }, "schemes": [ "http", diff --git a/desc/api/docs/shop-api.json b/desc/api/docs/shop-api.json index 8d3e078..d2c3a28 100644 --- a/desc/api/docs/shop-api.json +++ b/desc/api/docs/shop-api.json @@ -1,8 +1,9 @@ { "swagger": "2.0", "info": { - "title": "", - "version": "" + "title": "聚玩店铺服务", + "description": "管理店铺信息、员工邀请、模板配置。ID 字段（int64）以 string 传输", + "version": "1.0" }, "schemes": [ "http", diff --git a/desc/api/docs/users-api.json b/desc/api/docs/users-api.json index 90a9b65..1748560 100644 --- a/desc/api/docs/users-api.json +++ b/desc/api/docs/users-api.json @@ -2,7 +2,7 @@ "swagger": "2.0", "info": { "title": "聚玩用户服务", - "description": "处理用户注册、登录、个人信息管理及关注系统", + "description": "处理用户注册、登录、个人信息管理及关注系统。ID 字段（int64）以 string 传输", "version": "1.0" }, "schemes": [ diff --git a/desc/api/docs/wallet-api.json b/desc/api/docs/wallet-api.json index 9372c1f..8716c66 100644 --- a/desc/api/docs/wallet-api.json +++ b/desc/api/docs/wallet-api.json @@ -2,7 +2,7 @@ "swagger": "2.0", "info": { "title": "钱包服务", - "description": "处理钱包充值相关", + "description": "处理钱包充值相关。ID 字段（int64）以 string 传输", "version": "1.0" }, "schemes": [ diff --git a/desc/api/email.api b/desc/api/email.api index e4f171d..1cca76b 100644 --- a/desc/api/email.api +++ b/desc/api/email.api @@ -1,6 +1,8 @@ syntax = "v1" info ( + title: "聚玩邮件服务" + desc: "处理邮件验证码发送与密码找回" author: "Asadz" date: "2024-06-19" version: "1.0" diff --git a/desc/api/game.api b/desc/api/game.api index 423b8d3..c243066 100644 --- a/desc/api/game.api +++ b/desc/api/game.api @@ -2,6 +2,13 @@ syntax = "v1" import "common.api" +info ( + title: "聚玩游戏服务" + desc: "管理游戏目录与分类。ID 字段（int64）以 string 传输" + author: "Asadz" + version: "1.0" +) + type ( Game { Id int64 `json:"id,string,optional"` diff --git a/desc/api/notification.api b/desc/api/notification.api index 608e4e0..1b3a18e 100644 --- a/desc/api/notification.api +++ b/desc/api/notification.api @@ -2,6 +2,13 @@ syntax = "v1" import "common.api" +info ( + title: "聚玩通知服务" + desc: "管理站内消息通知。ID 字段（int64）以 string 传输" + author: "Asadz" + version: "1.0" +) + type ( PathId { Id int64 `path:"id"` diff --git a/desc/api/order.api b/desc/api/order.api index 34b47f7..1c430c1 100644 --- a/desc/api/order.api +++ b/desc/api/order.api @@ -4,7 +4,7 @@ import "common.api" info ( title: "聚玩订单服务" - desc: "处理订单业务" + desc: "处理订单业务。ID 字段（int64）以 string 传输" author: "Asadz" version: "1.0" ) diff --git a/desc/api/player.api b/desc/api/player.api index 7309813..1f33e68 100644 --- a/desc/api/player.api +++ b/desc/api/player.api @@ -2,7 +2,7 @@ syntax = "v1" info ( title: "聚玩打手服务" - desc: "聚玩用户服务处理打手信息管理、服务发布及订单相关接口" + desc: "聚玩用户服务处理打手信息管理、服务发布及订单相关接口。ID 字段（int64）以 string 传输" author: "Asadz" version: "1.0" ) diff --git a/desc/api/review.api b/desc/api/review.api index 7a67046..2209140 100644 --- a/desc/api/review.api +++ b/desc/api/review.api @@ -2,6 +2,13 @@ syntax = "v1" import "common.api" +info ( + title: "聚玩评价服务" + desc: "处理订单评价与评分。ID 字段（int64）以 string 传输" + author: "Asadz" + version: "1.0" +) + type ( ReviewPathId { Id int64 `path:"id"` diff --git a/desc/api/search.api b/desc/api/search.api index 17636b6..8ad0b27 100644 --- a/desc/api/search.api +++ b/desc/api/search.api @@ -2,6 +2,13 @@ syntax = "v1" import "common.api" +info ( + title: "聚玩搜索服务" + desc: "内容搜索与首页推荐" + author: "Asadz" + version: "1.0" +) + type ( PathIDReq { Id int64 `path:"id"` diff --git a/desc/api/shop.api b/desc/api/shop.api index 96278e1..f5d5079 100644 --- a/desc/api/shop.api +++ b/desc/api/shop.api @@ -2,6 +2,13 @@ syntax = "v1" import "common.api" +info ( + title: "聚玩店铺服务" + desc: "管理店铺信息、员工邀请、模板配置。ID 字段（int64）以 string 传输" + author: "Asadz" + version: "1.0" +) + type ( ShopProfile { Id string `json:"id"` diff --git a/desc/api/users.api b/desc/api/users.api index cda3ab5..315b5e5 100644 --- a/desc/api/users.api +++ b/desc/api/users.api @@ -2,7 +2,7 @@ syntax = "v1" info ( title: "聚玩用户服务" - desc: "处理用户注册、登录、个人信息管理及关注系统" + desc: "处理用户注册、登录、个人信息管理及关注系统。ID 字段（int64）以 string 传输" author: "Asadz" version: "1.0" ) diff --git a/desc/api/wallet.api b/desc/api/wallet.api index 812f1f8..46d04d3 100644 --- a/desc/api/wallet.api +++ b/desc/api/wallet.api @@ -2,7 +2,7 @@ syntax = "v1" info ( title: "钱包服务" - desc: "处理钱包充值相关" + desc: "处理钱包充值相关。ID 字段（int64）以 string 传输" author: "Asadz" version: "1.0" )