547 lines
12 KiB
JSON
547 lines
12 KiB
JSON
{
|
||
"swagger": "2.0",
|
||
"info": {
|
||
"title": "rs_common.proto",
|
||
"version": "version not set"
|
||
},
|
||
"tags": [
|
||
{
|
||
"name": "Gateway"
|
||
},
|
||
{
|
||
"name": "ThirdParty"
|
||
},
|
||
{
|
||
"name": "User"
|
||
}
|
||
],
|
||
"consumes": [
|
||
"application/json"
|
||
],
|
||
"produces": [
|
||
"application/json"
|
||
],
|
||
"paths": {
|
||
"/third-party/open/code_voucher": {
|
||
"post": {
|
||
"summary": "获取验证码凭证",
|
||
"operationId": "ThirdParty_AppGetCodeVoucher",
|
||
"responses": {
|
||
"200": {
|
||
"description": "A successful response.",
|
||
"schema": {
|
||
"$ref": "#/definitions/AppGetCodeVoucherResp"
|
||
}
|
||
}
|
||
},
|
||
"parameters": [
|
||
{
|
||
"name": "body",
|
||
"in": "body",
|
||
"required": true,
|
||
"schema": {
|
||
"$ref": "#/definitions/AppGetCodeVoucherReq"
|
||
}
|
||
}
|
||
],
|
||
"tags": [
|
||
"ThirdParty"
|
||
]
|
||
}
|
||
},
|
||
"/third-party/open/login": {
|
||
"post": {
|
||
"summary": "登录",
|
||
"operationId": "ThirdParty_AppLogin",
|
||
"responses": {
|
||
"200": {
|
||
"description": "A successful response.",
|
||
"schema": {
|
||
"$ref": "#/definitions/AppLoginResp"
|
||
}
|
||
}
|
||
},
|
||
"parameters": [
|
||
{
|
||
"name": "body",
|
||
"in": "body",
|
||
"required": true,
|
||
"schema": {
|
||
"$ref": "#/definitions/AppLoginReq"
|
||
}
|
||
}
|
||
],
|
||
"tags": [
|
||
"ThirdParty"
|
||
]
|
||
}
|
||
},
|
||
"/third-party/open/login_bind": {
|
||
"post": {
|
||
"summary": "绑定手机号",
|
||
"operationId": "ThirdParty_AppBindPhone",
|
||
"responses": {
|
||
"200": {
|
||
"description": "A successful response.",
|
||
"schema": {
|
||
"$ref": "#/definitions/AppLoginResp"
|
||
}
|
||
}
|
||
},
|
||
"parameters": [
|
||
{
|
||
"name": "body",
|
||
"in": "body",
|
||
"required": true,
|
||
"schema": {
|
||
"$ref": "#/definitions/AppBindPhoneReq"
|
||
}
|
||
}
|
||
],
|
||
"tags": [
|
||
"ThirdParty"
|
||
]
|
||
}
|
||
},
|
||
"/third-party/open/logout": {
|
||
"post": {
|
||
"summary": "登出",
|
||
"operationId": "ThirdParty_AppLogout",
|
||
"responses": {
|
||
"200": {
|
||
"description": "A successful response.",
|
||
"schema": {
|
||
"$ref": "#/definitions/AppLogoutResp"
|
||
}
|
||
}
|
||
},
|
||
"parameters": [
|
||
{
|
||
"name": "body",
|
||
"in": "body",
|
||
"required": true,
|
||
"schema": {
|
||
"$ref": "#/definitions/AppLogoutReq"
|
||
}
|
||
}
|
||
],
|
||
"tags": [
|
||
"ThirdParty"
|
||
]
|
||
}
|
||
},
|
||
"/third-party/open/refresh_token": {
|
||
"post": {
|
||
"summary": "刷新令牌",
|
||
"operationId": "ThirdParty_AppRefreshToken",
|
||
"responses": {
|
||
"200": {
|
||
"description": "A successful response.",
|
||
"schema": {
|
||
"$ref": "#/definitions/AppRefreshTokenResp"
|
||
}
|
||
}
|
||
},
|
||
"parameters": [
|
||
{
|
||
"name": "body",
|
||
"in": "body",
|
||
"required": true,
|
||
"schema": {
|
||
"$ref": "#/definitions/AppRefreshTokenReq"
|
||
}
|
||
}
|
||
],
|
||
"tags": [
|
||
"ThirdParty"
|
||
]
|
||
}
|
||
},
|
||
"/third-party/open/send_code": {
|
||
"post": {
|
||
"summary": "发送验证码",
|
||
"operationId": "ThirdParty_AppSendCode",
|
||
"responses": {
|
||
"200": {
|
||
"description": "A successful response.",
|
||
"schema": {
|
||
"$ref": "#/definitions/AppSendCodeResp"
|
||
}
|
||
}
|
||
},
|
||
"parameters": [
|
||
{
|
||
"name": "body",
|
||
"in": "body",
|
||
"required": true,
|
||
"schema": {
|
||
"$ref": "#/definitions/AppSendCodeReq"
|
||
}
|
||
}
|
||
],
|
||
"tags": [
|
||
"ThirdParty"
|
||
]
|
||
}
|
||
},
|
||
"/user/auth/info": {
|
||
"post": {
|
||
"summary": "查询用户信息",
|
||
"operationId": "User_AppFindUser",
|
||
"responses": {
|
||
"200": {
|
||
"description": "A successful response.",
|
||
"schema": {
|
||
"$ref": "#/definitions/AppFindUserResp"
|
||
}
|
||
}
|
||
},
|
||
"parameters": [
|
||
{
|
||
"name": "body",
|
||
"in": "body",
|
||
"required": true,
|
||
"schema": {
|
||
"$ref": "#/definitions/AppFindUserReq"
|
||
}
|
||
}
|
||
],
|
||
"tags": [
|
||
"User"
|
||
]
|
||
}
|
||
},
|
||
"/user/auth/modify/nick_and_avatar": {
|
||
"post": {
|
||
"summary": "更新用户昵称和头像",
|
||
"operationId": "User_AppUpdateUserNickAndAvatar",
|
||
"responses": {
|
||
"200": {
|
||
"description": "A successful response.",
|
||
"schema": {
|
||
"$ref": "#/definitions/AppUpdateUserNickAndAvatarResp"
|
||
}
|
||
}
|
||
},
|
||
"parameters": [
|
||
{
|
||
"name": "body",
|
||
"in": "body",
|
||
"required": true,
|
||
"schema": {
|
||
"$ref": "#/definitions/AppUpdateUserNickAndAvatarReq"
|
||
}
|
||
}
|
||
],
|
||
"tags": [
|
||
"User"
|
||
]
|
||
}
|
||
}
|
||
},
|
||
"definitions": {
|
||
"AppBindPhoneReq": {
|
||
"type": "object",
|
||
"properties": {
|
||
"ticket": {
|
||
"type": "string",
|
||
"title": "凭证"
|
||
},
|
||
"countryCode": {
|
||
"type": "string",
|
||
"title": "国家码"
|
||
},
|
||
"phone": {
|
||
"type": "string",
|
||
"title": "手机号"
|
||
},
|
||
"code": {
|
||
"type": "string",
|
||
"title": "验证码"
|
||
},
|
||
"miniPhoneCode": {
|
||
"type": "string",
|
||
"title": "微信小程序手机凭证"
|
||
}
|
||
},
|
||
"title": "---------- AppBindPhone ----------"
|
||
},
|
||
"AppFindUserReq": {
|
||
"type": "object",
|
||
"title": "---------- AppFindUser ----------"
|
||
},
|
||
"AppFindUserResp": {
|
||
"type": "object",
|
||
"properties": {
|
||
"usn": {
|
||
"type": "string",
|
||
"format": "int64"
|
||
},
|
||
"uid": {
|
||
"type": "string",
|
||
"title": "用户唯一编号，仅用于展示"
|
||
},
|
||
"name": {
|
||
"type": "string",
|
||
"title": "用户名"
|
||
},
|
||
"headURL": {
|
||
"type": "string",
|
||
"title": "头像"
|
||
},
|
||
"isDefaultName": {
|
||
"type": "boolean",
|
||
"title": "是否是默认头像"
|
||
}
|
||
}
|
||
},
|
||
"AppGetCodeVoucherReq": {
|
||
"type": "object",
|
||
"properties": {
|
||
"countryCode": {
|
||
"type": "string",
|
||
"title": "国家码"
|
||
},
|
||
"phone": {
|
||
"type": "string",
|
||
"title": "手机号"
|
||
},
|
||
"code": {
|
||
"type": "string",
|
||
"title": "验证码"
|
||
}
|
||
},
|
||
"title": "---------- AppGetCodeVoucher ----------"
|
||
},
|
||
"AppGetCodeVoucherResp": {
|
||
"type": "object",
|
||
"properties": {
|
||
"codeVoucher": {
|
||
"type": "string",
|
||
"title": "凭证"
|
||
}
|
||
}
|
||
},
|
||
"AppLoginReq": {
|
||
"type": "object",
|
||
"properties": {
|
||
"type": {
|
||
"$ref": "#/definitions/LoginType",
|
||
"title": "登录方式"
|
||
},
|
||
"platformType": {
|
||
"$ref": "#/definitions/PlatformType",
|
||
"title": "平台类型"
|
||
},
|
||
"countryCode": {
|
||
"type": "string",
|
||
"title": "国家码"
|
||
},
|
||
"phone": {
|
||
"type": "string",
|
||
"title": "手机号"
|
||
},
|
||
"code": {
|
||
"type": "string",
|
||
"title": "验证码"
|
||
},
|
||
"wxMiniCode": {
|
||
"type": "string",
|
||
"title": "微信小程序登录凭证"
|
||
},
|
||
"wxAppCode": {
|
||
"type": "string",
|
||
"title": "微信App登录凭证"
|
||
},
|
||
"identityToken": {
|
||
"type": "string",
|
||
"title": "苹果登录凭证"
|
||
},
|
||
"fullName": {
|
||
"type": "string",
|
||
"title": "苹果全称"
|
||
},
|
||
"email": {
|
||
"type": "string",
|
||
"title": "邮箱"
|
||
}
|
||
},
|
||
"title": "---------- AppLogin ----------"
|
||
},
|
||
"AppLoginResp": {
|
||
"type": "object",
|
||
"properties": {
|
||
"status": {
|
||
"type": "integer",
|
||
"format": "int32",
|
||
"title": "状态 0 成功 1 需要绑定手机号"
|
||
},
|
||
"ticket": {
|
||
"type": "string",
|
||
"title": "凭证"
|
||
},
|
||
"usn": {
|
||
"type": "string",
|
||
"format": "int64",
|
||
"title": "用户ID"
|
||
},
|
||
"accessToken": {
|
||
"type": "string"
|
||
},
|
||
"refreshToken": {
|
||
"type": "string"
|
||
},
|
||
"isMaintain": {
|
||
"type": "boolean",
|
||
"title": "服务器是否在维护"
|
||
}
|
||
}
|
||
},
|
||
"AppLogoutReq": {
|
||
"type": "object",
|
||
"properties": {
|
||
"refreshToken": {
|
||
"type": "string"
|
||
}
|
||
},
|
||
"title": "---------- AppLogout ----------"
|
||
},
|
||
"AppLogoutResp": {
|
||
"type": "object"
|
||
},
|
||
"AppRefreshTokenReq": {
|
||
"type": "object",
|
||
"properties": {
|
||
"refreshToken": {
|
||
"type": "string"
|
||
}
|
||
},
|
||
"title": "---------- AppRefreshToken ----------"
|
||
},
|
||
"AppRefreshTokenResp": {
|
||
"type": "object",
|
||
"properties": {
|
||
"accessToken": {
|
||
"type": "string"
|
||
},
|
||
"refreshToken": {
|
||
"type": "string"
|
||
},
|
||
"isMaintain": {
|
||
"type": "boolean"
|
||
}
|
||
}
|
||
},
|
||
"AppSendCodeReq": {
|
||
"type": "object",
|
||
"properties": {
|
||
"phone": {
|
||
"type": "string"
|
||
},
|
||
"countryCode": {
|
||
"type": "string"
|
||
}
|
||
},
|
||
"title": "---------- AppSendCode ----------"
|
||
},
|
||
"AppSendCodeResp": {
|
||
"type": "object"
|
||
},
|
||
"AppUpdateUserNickAndAvatarReq": {
|
||
"type": "object",
|
||
"properties": {
|
||
"nickName": {
|
||
"type": "string",
|
||
"title": "昵称"
|
||
},
|
||
"isUpdateAvatar": {
|
||
"type": "boolean",
|
||
"title": "是否更新头像"
|
||
}
|
||
},
|
||
"title": "---------- AppUpdateUserNickAndAvatar ----------"
|
||
},
|
||
"AppUpdateUserNickAndAvatarResp": {
|
||
"type": "object",
|
||
"properties": {
|
||
"uploadURL": {
|
||
"type": "string",
|
||
"title": "头像上传URL"
|
||
}
|
||
}
|
||
},
|
||
"InnerBroadcastChannelResp": {
|
||
"type": "object"
|
||
},
|
||
"InnerBroadcastClientResp": {
|
||
"type": "object"
|
||
},
|
||
"InnerCheckCodeResp": {
|
||
"type": "object",
|
||
"properties": {
|
||
"success": {
|
||
"type": "boolean"
|
||
}
|
||
}
|
||
},
|
||
"InnerCheckCodeVoucherResp": {
|
||
"type": "object",
|
||
"properties": {
|
||
"success": {
|
||
"type": "boolean"
|
||
},
|
||
"phone": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"InnerKickOfflineResp": {
|
||
"type": "object"
|
||
},
|
||
"InnerKickUserResp": {
|
||
"type": "object"
|
||
},
|
||
"InnerToClientResp": {
|
||
"type": "object"
|
||
},
|
||
"LoginType": {
|
||
"type": "string",
|
||
"enum": [
|
||
"LOGIN_TYPE_UNKNOWN",
|
||
"LOGIN_TYPE_PHONE",
|
||
"LOGIN_TYPE_WX_MINI",
|
||
"LOGIN_TYPE_WX_APP",
|
||
"LOGIN_TYPE_APPLE"
|
||
],
|
||
"default": "LOGIN_TYPE_UNKNOWN",
|
||
"title": "- LOGIN_TYPE_PHONE: 手机号\n - LOGIN_TYPE_WX_MINI: 微信小程序\n - LOGIN_TYPE_WX_APP: 微信App\n - LOGIN_TYPE_APPLE: 苹果"
|
||
},
|
||
"PlatformType": {
|
||
"type": "string",
|
||
"enum": [
|
||
"PLATFORM_TYPE_UNKNOWN",
|
||
"PLATFORM_TYPE_GAME",
|
||
"PLATFORM_TYPE_WX_MINI",
|
||
"PLATFORM_TYPE_ADMIN"
|
||
],
|
||
"default": "PLATFORM_TYPE_UNKNOWN",
|
||
"title": "- PLATFORM_TYPE_GAME: 游戏（APP）\n - PLATFORM_TYPE_WX_MINI: 微信小程序\n - PLATFORM_TYPE_ADMIN: 后台"
|
||
},
|
||
"UserBaseInfo": {
|
||
"type": "object",
|
||
"properties": {
|
||
"USN": {
|
||
"type": "string",
|
||
"format": "int64",
|
||
"title": "用户ID"
|
||
},
|
||
"IsBindPhone": {
|
||
"type": "boolean",
|
||
"title": "是否绑定手机号"
|
||
}
|
||
},
|
||
"title": "用户基础信息"
|
||
}
|
||
}
|
||
}
|