docs: 在接口文档补全 title 与 desc 并标注 ID 序列化形式
This commit is contained in:
@@ -2,6 +2,13 @@ syntax = "v1"
|
|||||||
|
|
||||||
import "common.api"
|
import "common.api"
|
||||||
|
|
||||||
|
info (
|
||||||
|
title: "聚玩社区服务"
|
||||||
|
desc: "处理帖子、评论、点赞等社区互动。ID 字段(int64)以 string 传输"
|
||||||
|
author: "Asadz"
|
||||||
|
version: "1.0"
|
||||||
|
)
|
||||||
|
|
||||||
type (
|
type (
|
||||||
PathId {
|
PathId {
|
||||||
Id int64 `path:"id"`
|
Id int64 `path:"id"`
|
||||||
|
|||||||
@@ -2,6 +2,13 @@ syntax = "v1"
|
|||||||
|
|
||||||
import "common.api"
|
import "common.api"
|
||||||
|
|
||||||
|
info (
|
||||||
|
title: "聚玩争议服务"
|
||||||
|
desc: "处理订单争议申诉与仲裁。ID 字段(int64)以 string 传输"
|
||||||
|
author: "Asadz"
|
||||||
|
version: "1.0"
|
||||||
|
)
|
||||||
|
|
||||||
type (
|
type (
|
||||||
DisputePathId {
|
DisputePathId {
|
||||||
Id int64 `path:"id"`
|
Id int64 `path:"id"`
|
||||||
|
|||||||
@@ -1,8 +1,9 @@
|
|||||||
{
|
{
|
||||||
"swagger": "2.0",
|
"swagger": "2.0",
|
||||||
"info": {
|
"info": {
|
||||||
"title": "",
|
"title": "聚玩社区服务",
|
||||||
"version": ""
|
"description": "处理帖子、评论、点赞等社区互动。ID 字段(int64)以 string 传输",
|
||||||
|
"version": "1.0"
|
||||||
},
|
},
|
||||||
"schemes": [
|
"schemes": [
|
||||||
"http",
|
"http",
|
||||||
|
|||||||
@@ -1,8 +1,9 @@
|
|||||||
{
|
{
|
||||||
"swagger": "2.0",
|
"swagger": "2.0",
|
||||||
"info": {
|
"info": {
|
||||||
"title": "",
|
"title": "聚玩争议服务",
|
||||||
"version": ""
|
"description": "处理订单争议申诉与仲裁。ID 字段(int64)以 string 传输",
|
||||||
|
"version": "1.0"
|
||||||
},
|
},
|
||||||
"schemes": [
|
"schemes": [
|
||||||
"http",
|
"http",
|
||||||
|
|||||||
@@ -1,7 +1,8 @@
|
|||||||
{
|
{
|
||||||
"swagger": "2.0",
|
"swagger": "2.0",
|
||||||
"info": {
|
"info": {
|
||||||
"title": "",
|
"title": "聚玩邮件服务",
|
||||||
|
"description": "处理邮件验证码发送与密码找回",
|
||||||
"version": "1.0"
|
"version": "1.0"
|
||||||
},
|
},
|
||||||
"schemes": [
|
"schemes": [
|
||||||
|
|||||||
@@ -1,8 +1,9 @@
|
|||||||
{
|
{
|
||||||
"swagger": "2.0",
|
"swagger": "2.0",
|
||||||
"info": {
|
"info": {
|
||||||
"title": "",
|
"title": "聚玩游戏服务",
|
||||||
"version": ""
|
"description": "管理游戏目录与分类。ID 字段(int64)以 string 传输",
|
||||||
|
"version": "1.0"
|
||||||
},
|
},
|
||||||
"schemes": [
|
"schemes": [
|
||||||
"http",
|
"http",
|
||||||
|
|||||||
@@ -1,8 +1,9 @@
|
|||||||
{
|
{
|
||||||
"swagger": "2.0",
|
"swagger": "2.0",
|
||||||
"info": {
|
"info": {
|
||||||
"title": "",
|
"title": "聚玩通知服务",
|
||||||
"version": ""
|
"description": "管理站内消息通知。ID 字段(int64)以 string 传输",
|
||||||
|
"version": "1.0"
|
||||||
},
|
},
|
||||||
"schemes": [
|
"schemes": [
|
||||||
"http",
|
"http",
|
||||||
|
|||||||
@@ -2,7 +2,7 @@
|
|||||||
"swagger": "2.0",
|
"swagger": "2.0",
|
||||||
"info": {
|
"info": {
|
||||||
"title": "聚玩订单服务",
|
"title": "聚玩订单服务",
|
||||||
"description": "处理订单业务",
|
"description": "处理订单业务。ID 字段(int64)以 string 传输",
|
||||||
"version": "1.0"
|
"version": "1.0"
|
||||||
},
|
},
|
||||||
"schemes": [
|
"schemes": [
|
||||||
|
|||||||
@@ -2,7 +2,7 @@
|
|||||||
"swagger": "2.0",
|
"swagger": "2.0",
|
||||||
"info": {
|
"info": {
|
||||||
"title": "聚玩打手服务",
|
"title": "聚玩打手服务",
|
||||||
"description": "聚玩用户服务处理打手信息管理、服务发布及订单相关接口",
|
"description": "聚玩用户服务处理打手信息管理、服务发布及订单相关接口。ID 字段(int64)以 string 传输",
|
||||||
"version": "1.0"
|
"version": "1.0"
|
||||||
},
|
},
|
||||||
"schemes": [
|
"schemes": [
|
||||||
|
|||||||
@@ -1,8 +1,9 @@
|
|||||||
{
|
{
|
||||||
"swagger": "2.0",
|
"swagger": "2.0",
|
||||||
"info": {
|
"info": {
|
||||||
"title": "",
|
"title": "聚玩评价服务",
|
||||||
"version": ""
|
"description": "处理订单评价与评分。ID 字段(int64)以 string 传输",
|
||||||
|
"version": "1.0"
|
||||||
},
|
},
|
||||||
"schemes": [
|
"schemes": [
|
||||||
"http",
|
"http",
|
||||||
|
|||||||
@@ -1,8 +1,9 @@
|
|||||||
{
|
{
|
||||||
"swagger": "2.0",
|
"swagger": "2.0",
|
||||||
"info": {
|
"info": {
|
||||||
"title": "",
|
"title": "聚玩搜索服务",
|
||||||
"version": ""
|
"description": "内容搜索与首页推荐",
|
||||||
|
"version": "1.0"
|
||||||
},
|
},
|
||||||
"schemes": [
|
"schemes": [
|
||||||
"http",
|
"http",
|
||||||
|
|||||||
@@ -1,8 +1,9 @@
|
|||||||
{
|
{
|
||||||
"swagger": "2.0",
|
"swagger": "2.0",
|
||||||
"info": {
|
"info": {
|
||||||
"title": "",
|
"title": "聚玩店铺服务",
|
||||||
"version": ""
|
"description": "管理店铺信息、员工邀请、模板配置。ID 字段(int64)以 string 传输",
|
||||||
|
"version": "1.0"
|
||||||
},
|
},
|
||||||
"schemes": [
|
"schemes": [
|
||||||
"http",
|
"http",
|
||||||
|
|||||||
@@ -2,7 +2,7 @@
|
|||||||
"swagger": "2.0",
|
"swagger": "2.0",
|
||||||
"info": {
|
"info": {
|
||||||
"title": "聚玩用户服务",
|
"title": "聚玩用户服务",
|
||||||
"description": "处理用户注册、登录、个人信息管理及关注系统",
|
"description": "处理用户注册、登录、个人信息管理及关注系统。ID 字段(int64)以 string 传输",
|
||||||
"version": "1.0"
|
"version": "1.0"
|
||||||
},
|
},
|
||||||
"schemes": [
|
"schemes": [
|
||||||
|
|||||||
@@ -2,7 +2,7 @@
|
|||||||
"swagger": "2.0",
|
"swagger": "2.0",
|
||||||
"info": {
|
"info": {
|
||||||
"title": "钱包服务",
|
"title": "钱包服务",
|
||||||
"description": "处理钱包充值相关",
|
"description": "处理钱包充值相关。ID 字段(int64)以 string 传输",
|
||||||
"version": "1.0"
|
"version": "1.0"
|
||||||
},
|
},
|
||||||
"schemes": [
|
"schemes": [
|
||||||
|
|||||||
@@ -1,6 +1,8 @@
|
|||||||
syntax = "v1"
|
syntax = "v1"
|
||||||
|
|
||||||
info (
|
info (
|
||||||
|
title: "聚玩邮件服务"
|
||||||
|
desc: "处理邮件验证码发送与密码找回"
|
||||||
author: "Asadz"
|
author: "Asadz"
|
||||||
date: "2024-06-19"
|
date: "2024-06-19"
|
||||||
version: "1.0"
|
version: "1.0"
|
||||||
|
|||||||
@@ -2,6 +2,13 @@ syntax = "v1"
|
|||||||
|
|
||||||
import "common.api"
|
import "common.api"
|
||||||
|
|
||||||
|
info (
|
||||||
|
title: "聚玩游戏服务"
|
||||||
|
desc: "管理游戏目录与分类。ID 字段(int64)以 string 传输"
|
||||||
|
author: "Asadz"
|
||||||
|
version: "1.0"
|
||||||
|
)
|
||||||
|
|
||||||
type (
|
type (
|
||||||
Game {
|
Game {
|
||||||
Id int64 `json:"id,string,optional"`
|
Id int64 `json:"id,string,optional"`
|
||||||
|
|||||||
@@ -2,6 +2,13 @@ syntax = "v1"
|
|||||||
|
|
||||||
import "common.api"
|
import "common.api"
|
||||||
|
|
||||||
|
info (
|
||||||
|
title: "聚玩通知服务"
|
||||||
|
desc: "管理站内消息通知。ID 字段(int64)以 string 传输"
|
||||||
|
author: "Asadz"
|
||||||
|
version: "1.0"
|
||||||
|
)
|
||||||
|
|
||||||
type (
|
type (
|
||||||
PathId {
|
PathId {
|
||||||
Id int64 `path:"id"`
|
Id int64 `path:"id"`
|
||||||
|
|||||||
+1
-1
@@ -4,7 +4,7 @@ import "common.api"
|
|||||||
|
|
||||||
info (
|
info (
|
||||||
title: "聚玩订单服务"
|
title: "聚玩订单服务"
|
||||||
desc: "处理订单业务"
|
desc: "处理订单业务。ID 字段(int64)以 string 传输"
|
||||||
author: "Asadz"
|
author: "Asadz"
|
||||||
version: "1.0"
|
version: "1.0"
|
||||||
)
|
)
|
||||||
|
|||||||
+1
-1
@@ -2,7 +2,7 @@ syntax = "v1"
|
|||||||
|
|
||||||
info (
|
info (
|
||||||
title: "聚玩打手服务"
|
title: "聚玩打手服务"
|
||||||
desc: "聚玩用户服务处理打手信息管理、服务发布及订单相关接口"
|
desc: "聚玩用户服务处理打手信息管理、服务发布及订单相关接口。ID 字段(int64)以 string 传输"
|
||||||
author: "Asadz"
|
author: "Asadz"
|
||||||
version: "1.0"
|
version: "1.0"
|
||||||
)
|
)
|
||||||
|
|||||||
@@ -2,6 +2,13 @@ syntax = "v1"
|
|||||||
|
|
||||||
import "common.api"
|
import "common.api"
|
||||||
|
|
||||||
|
info (
|
||||||
|
title: "聚玩评价服务"
|
||||||
|
desc: "处理订单评价与评分。ID 字段(int64)以 string 传输"
|
||||||
|
author: "Asadz"
|
||||||
|
version: "1.0"
|
||||||
|
)
|
||||||
|
|
||||||
type (
|
type (
|
||||||
ReviewPathId {
|
ReviewPathId {
|
||||||
Id int64 `path:"id"`
|
Id int64 `path:"id"`
|
||||||
|
|||||||
@@ -2,6 +2,13 @@ syntax = "v1"
|
|||||||
|
|
||||||
import "common.api"
|
import "common.api"
|
||||||
|
|
||||||
|
info (
|
||||||
|
title: "聚玩搜索服务"
|
||||||
|
desc: "内容搜索与首页推荐"
|
||||||
|
author: "Asadz"
|
||||||
|
version: "1.0"
|
||||||
|
)
|
||||||
|
|
||||||
type (
|
type (
|
||||||
PathIDReq {
|
PathIDReq {
|
||||||
Id int64 `path:"id"`
|
Id int64 `path:"id"`
|
||||||
|
|||||||
@@ -2,6 +2,13 @@ syntax = "v1"
|
|||||||
|
|
||||||
import "common.api"
|
import "common.api"
|
||||||
|
|
||||||
|
info (
|
||||||
|
title: "聚玩店铺服务"
|
||||||
|
desc: "管理店铺信息、员工邀请、模板配置。ID 字段(int64)以 string 传输"
|
||||||
|
author: "Asadz"
|
||||||
|
version: "1.0"
|
||||||
|
)
|
||||||
|
|
||||||
type (
|
type (
|
||||||
ShopProfile {
|
ShopProfile {
|
||||||
Id string `json:"id"`
|
Id string `json:"id"`
|
||||||
|
|||||||
+1
-1
@@ -2,7 +2,7 @@ syntax = "v1"
|
|||||||
|
|
||||||
info (
|
info (
|
||||||
title: "聚玩用户服务"
|
title: "聚玩用户服务"
|
||||||
desc: "处理用户注册、登录、个人信息管理及关注系统"
|
desc: "处理用户注册、登录、个人信息管理及关注系统。ID 字段(int64)以 string 传输"
|
||||||
author: "Asadz"
|
author: "Asadz"
|
||||||
version: "1.0"
|
version: "1.0"
|
||||||
)
|
)
|
||||||
|
|||||||
+1
-1
@@ -2,7 +2,7 @@ syntax = "v1"
|
|||||||
|
|
||||||
info (
|
info (
|
||||||
title: "钱包服务"
|
title: "钱包服务"
|
||||||
desc: "处理钱包充值相关"
|
desc: "处理钱包充值相关。ID 字段(int64)以 string 传输"
|
||||||
author: "Asadz"
|
author: "Asadz"
|
||||||
version: "1.0"
|
version: "1.0"
|
||||||
)
|
)
|
||||||
|
|||||||
Reference in New Issue
Block a user