Browse Source

app-gateway

master
otto 2 months ago
parent
commit
889a7765e3
  1. 10
      Makefile
  2. 15
      app_gateway/v1/guild_gateway.swagger.json
  3. 15
      app_gateway/v1/guild_gateway.swagger.yaml
  4. 1
      app_gateway/v1/guild_params.proto
  5. 1690
      app_gateway/v1/room_gateway.swagger.json
  6. 1191
      app_gateway/v1/room_gateway.swagger.yaml
  7. 229
      app_gateway/v1/user_gateway.swagger.json
  8. 167
      app_gateway/v1/user_gateway.swagger.yaml

10
Makefile

@ -164,9 +164,9 @@ generate-app-gateway-api:
do \
ls $$dir | xargs -n1 -IX bash -c 'sed s/,omitempty// X > X.tmp && mv X{.tmp,}'; \
done
protoc --proto_path=. --proto_path=./third_party --openapiv2_out json_names_for_fields=false:. --openapiv2_opt logtostderr=true app_gateway/v1/app_gateway.proto; \
protoc --proto_path=. --proto_path=./third_party --openapiv2_out json_names_for_fields=false:. --openapiv2_opt logtostderr=true app_gateway/v1/*gateway.proto; \
protoc --proto_path=. --proto_path=./third_party --openapiv2_out json_names_for_fields=false:. \
--openapiv2_opt logtostderr=true --openapiv2_opt output_format=yaml app_gateway/v1/app_gateway.proto;
protoc --proto_path=. --proto_path=./third_party --openapiv2_out json_names_for_fields=false:. --openapiv2_opt logtostderr=true app_gateway/v1/guild_gateway.proto; \
protoc --proto_path=. --proto_path=./third_party --openapiv2_out json_names_for_fields=false:. \
--openapiv2_opt logtostderr=true --openapiv2_opt output_format=yaml app_gateway/v1/guild_gateway.proto;
--openapiv2_opt logtostderr=true --openapiv2_opt output_format=yaml app_gateway/v1/*gateway.proto;
#protoc --proto_path=. --proto_path=./third_party --openapiv2_out json_names_for_fields=false:. --openapiv2_opt logtostderr=true app_gateway/v1/guild_gateway.proto; \
# protoc --proto_path=. --proto_path=./third_party --openapiv2_out json_names_for_fields=false:. \
# --openapiv2_opt logtostderr=true --openapiv2_opt output_format=yaml app_gateway/v1/guild_gateway.proto;

15
app_gateway/v1/guild_gateway.swagger.json

@ -24,7 +24,7 @@
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/v1Empty"
"$ref": "#/definitions/app_gatewayv1Empty"
}
},
"default": {
@ -156,7 +156,7 @@
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/v1Empty"
"$ref": "#/definitions/app_gatewayv1Empty"
}
},
"default": {
@ -256,7 +256,7 @@
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/v1Empty"
"$ref": "#/definitions/app_gatewayv1Empty"
}
},
"default": {
@ -323,7 +323,7 @@
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/v1Empty"
"$ref": "#/definitions/app_gatewayv1Empty"
}
},
"default": {
@ -350,6 +350,9 @@
}
},
"definitions": {
"app_gatewayv1Empty": {
"type": "object"
},
"protobufAny": {
"type": "object",
"properties": {
@ -413,9 +416,6 @@
},
"title": "删除公会主播请求"
},
"v1Empty": {
"type": "object"
},
"v1GetAnchorStatisticsListRequest": {
"type": "object",
"properties": {
@ -1048,7 +1048,6 @@
},
"password": {
"type": "string",
"description": "登录渠道枚举值, 1:app, 2:web\n int32 channel = 3;",
"title": "sha256(密码原文)"
}
},

15
app_gateway/v1/guild_gateway.swagger.yaml

@ -17,7 +17,7 @@ paths:
"200":
description: A successful response.
schema:
$ref: '#/definitions/v1Empty'
$ref: '#/definitions/app_gatewayv1Empty'
default:
description: An unexpected error response.
schema:
@ -101,7 +101,7 @@ paths:
"200":
description: A successful response.
schema:
$ref: '#/definitions/v1Empty'
$ref: '#/definitions/app_gatewayv1Empty'
default:
description: An unexpected error response.
schema:
@ -167,7 +167,7 @@ paths:
"200":
description: A successful response.
schema:
$ref: '#/definitions/v1Empty'
$ref: '#/definitions/app_gatewayv1Empty'
default:
description: An unexpected error response.
schema:
@ -212,7 +212,7 @@ paths:
"200":
description: A successful response.
schema:
$ref: '#/definitions/v1Empty'
$ref: '#/definitions/app_gatewayv1Empty'
default:
description: An unexpected error response.
schema:
@ -226,6 +226,8 @@ paths:
tags:
- GuildGateway
definitions:
app_gatewayv1Empty:
type: object
protobufAny:
type: object
properties:
@ -273,8 +275,6 @@ definitions:
format: int64
title: 用户id
title: 删除公会主播请求
v1Empty:
type: object
v1GetAnchorStatisticsListRequest:
type: object
properties:
@ -757,9 +757,6 @@ definitions:
title: 用户名,可以是:手机号
password:
type: string
description: |-
登录渠道枚举值, 1:app, 2:web
int32 channel = 3;
title: sha256(密码原文)
title: 公会后台登录请求
v1GuildLoginResponse:

1
app_gateway/v1/guild_params.proto

@ -9,6 +9,7 @@ message GuildLoginRequest {
string username = 1;
// sha256()
string password = 2;
// 1app 2web
// int32 channel = 3;
}

1690
app_gateway/v1/room_gateway.swagger.json

File diff suppressed because it is too large Load Diff

1191
app_gateway/v1/room_gateway.swagger.yaml

File diff suppressed because it is too large Load Diff

229
app_gateway/v1/user_gateway.swagger.json

@ -0,0 +1,229 @@
{
"swagger": "2.0",
"info": {
"title": "app_gateway/v1/user_gateway.proto",
"version": "version not set"
},
"tags": [
{
"name": "UserGateway"
}
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"paths": {
"/v1/user_profile/query": {
"get": {
"summary": "查询用户详情信息",
"operationId": "UserGateway_QueryUserProfile",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/v1QueryUserProfileResponse"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/rpcStatus"
}
}
},
"parameters": [
{
"name": "uid",
"description": "用户id【后期废弃】",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "role_id",
"description": "用户id,不传默认获取当前用户",
"in": "query",
"required": false,
"type": "string",
"format": "int64"
},
{
"name": "public_id",
"description": "用户号,不传默认获取当前用户",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "phone",
"description": "手机号码",
"in": "query",
"required": false,
"type": "string"
}
],
"tags": [
"UserGateway"
]
}
}
},
"definitions": {
"protobufAny": {
"type": "object",
"properties": {
"@type": {
"type": "string"
}
},
"additionalProperties": {}
},
"rpcStatus": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"format": "int32"
},
"message": {
"type": "string"
},
"details": {
"type": "array",
"items": {
"type": "object",
"$ref": "#/definitions/protobufAny"
}
}
}
},
"v1QueryUserProfileResponse": {
"type": "object",
"properties": {
"uid": {
"type": "string",
"title": "用户id 【废弃】"
},
"username": {
"type": "string",
"title": "昵称"
},
"sex": {
"$ref": "#/definitions/v1UserSex",
"title": "性别 1男 2女 3其他"
},
"avatar_url": {
"type": "string",
"title": "头像地址"
},
"role_id": {
"type": "string",
"format": "int64",
"title": "用户id"
},
"public_id": {
"type": "string",
"title": "用户号"
},
"description": {
"type": "string",
"title": "用户描述"
},
"is_follow": {
"type": "boolean",
"title": "是否已关注,当查询其他用户资料时,会有该字段"
},
"level": {
"type": "string",
"title": "等级"
},
"growth_value": {
"type": "string",
"format": "int64",
"title": "成长值"
},
"phone": {
"type": "string",
"title": "手机号码"
},
"data_birth": {
"type": "string",
"format": "int64",
"title": "出生日期的时间戳"
},
"avatar_extra": {
"type": "string",
"title": "头像备注"
},
"charm_level": {
"type": "string",
"title": "魅力等级"
},
"charm_growth_value": {
"type": "string",
"format": "int64",
"title": "魅力成长值"
},
"need_dress_up_mall_guide": {
"type": "boolean",
"title": "是否需要装扮商城指南"
},
"need_dress_up_warehouse_guide": {
"type": "boolean",
"title": "是否需要装扮仓库指南"
},
"need_room_guide": {
"type": "boolean",
"title": "是否需要房间指南"
},
"show_winning_lottery": {
"type": "boolean",
"title": "是否显示中奖信息"
},
"star_sign": {
"type": "string",
"title": "个性签名"
},
"location": {
"type": "string",
"title": "地址"
},
"age_show": {
"type": "string",
"title": "年龄"
},
"gift_wall_count": {
"type": "integer",
"format": "int32",
"title": "礼物墙数量"
},
"lighten_gift_wall_count": {
"type": "integer",
"format": "int32",
"title": "点亮礼物墙数"
},
"collect_start_count": {
"type": "integer",
"format": "int32",
"title": "收集的星星数"
}
},
"title": "用户详情信息响应"
},
"v1UserSex": {
"type": "string",
"enum": [
"UNKNOWN",
"MALE",
"FEMALE",
"OTHER"
],
"default": "UNKNOWN",
"description": "- MALE: 男\n - FEMALE: 女\n - OTHER: 其他",
"title": "性别"
}
}
}

167
app_gateway/v1/user_gateway.swagger.yaml

@ -0,0 +1,167 @@
swagger: "2.0"
info:
title: app_gateway/v1/user_gateway.proto
version: version not set
tags:
- name: UserGateway
consumes:
- application/json
produces:
- application/json
paths:
/v1/user_profile/query:
get:
summary: 查询用户详情信息
operationId: UserGateway_QueryUserProfile
responses:
"200":
description: A successful response.
schema:
$ref: '#/definitions/v1QueryUserProfileResponse'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/rpcStatus'
parameters:
- name: uid
description: 用户id【后期废弃】
in: query
required: false
type: string
- name: role_id
description: 用户id,不传默认获取当前用户
in: query
required: false
type: string
format: int64
- name: public_id
description: 用户号,不传默认获取当前用户
in: query
required: false
type: string
- name: phone
description: 手机号码
in: query
required: false
type: string
tags:
- UserGateway
definitions:
protobufAny:
type: object
properties:
'@type':
type: string
additionalProperties: {}
rpcStatus:
type: object
properties:
code:
type: integer
format: int32
message:
type: string
details:
type: array
items:
type: object
$ref: '#/definitions/protobufAny'
v1QueryUserProfileResponse:
type: object
properties:
uid:
type: string
title: 用户id 【废弃】
username:
type: string
title: 昵称
sex:
$ref: '#/definitions/v1UserSex'
title: 性别 1男 2女 3其他
avatar_url:
type: string
title: 头像地址
role_id:
type: string
format: int64
title: 用户id
public_id:
type: string
title: 用户号
description:
type: string
title: 用户描述
is_follow:
type: boolean
title: 是否已关注,当查询其他用户资料时,会有该字段
level:
type: string
title: 等级
growth_value:
type: string
format: int64
title: 成长值
phone:
type: string
title: 手机号码
data_birth:
type: string
format: int64
title: 出生日期的时间戳
avatar_extra:
type: string
title: 头像备注
charm_level:
type: string
title: 魅力等级
charm_growth_value:
type: string
format: int64
title: 魅力成长值
need_dress_up_mall_guide:
type: boolean
title: 是否需要装扮商城指南
need_dress_up_warehouse_guide:
type: boolean
title: 是否需要装扮仓库指南
need_room_guide:
type: boolean
title: 是否需要房间指南
show_winning_lottery:
type: boolean
title: 是否显示中奖信息
star_sign:
type: string
title: 个性签名
location:
type: string
title: 地址
age_show:
type: string
title: 年龄
gift_wall_count:
type: integer
format: int32
title: 礼物墙数量
lighten_gift_wall_count:
type: integer
format: int32
title: 点亮礼物墙数
collect_start_count:
type: integer
format: int32
title: 收集的星星数
title: 用户详情信息响应
v1UserSex:
type: string
enum:
- UNKNOWN
- MALE
- FEMALE
- OTHER
default: UNKNOWN
description: |-
- MALE:
- FEMALE:
- OTHER: 其他
title: 性别
Loading…
Cancel
Save