Generated By Cato (1780127271)

Download OpenAPI specification:

CommentApis

// 上传评论图片

// 上传评论图片

Request Body schema: application/json
required
client_md5
string
content_type
string
file
string <binary>
file_name
string

Responses

Request samples

Content type
application/json
{
  • "client_md5": "string",
  • "content_type": "string",
  • "file": "string",
  • "file_name": "string"
}

Response samples

Content type
application/json
{
  • "body": {
    },
  • "code": "string",
  • "message": "string"
}

// 删除评论

// 删除评论

Request Body schema: application/json
required
comment_id
string

Responses

Request samples

Content type
application/json
{
  • "comment_id": "string"
}

Response samples

Content type
application/json
{
  • "body": {
    },
  • "code": "string",
  • "message": "string"
}

// 获取评论详情

// 获取评论详情

Request Body schema: application/json
required
comment_id
string
cursor
string
limit
int64

Responses

Request samples

Content type
application/json
{
  • "comment_id": "string",
  • "cursor": "string",
  • "limit": null
}

Response samples

Content type
application/json
{
  • "body": {
    },
  • "code": "string",
  • "message": "string"
}

// 获取内容评论列表

// 获取内容评论列表

Request Body schema: application/json
required
content_id
string
content_type
string
cursor
string
limit
int64

Responses

Request samples

Content type
application/json
{
  • "content_id": "string",
  • "content_type": "string",
  • "cursor": "string",
  • "limit": null
}

Response samples

Content type
application/json
{
  • "body": {
    },
  • "code": "string",
  • "message": "string"
}

// 发布评论

// 发布评论

Request Body schema: application/json
required
content_id
string
content_type
string
object (locus.models.params.common.comment.CommentImageInput)
mentioned_user_ids
Array of strings
parent_comment_id
string
reply_to_user_id
string
text
string

Responses

Request samples

Content type
application/json
{
  • "content_id": "string",
  • "content_type": "string",
  • "image": {
    },
  • "mentioned_user_ids": [
    ],
  • "parent_comment_id": "string",
  • "reply_to_user_id": "string",
  • "text": "string"
}

Response samples

Content type
application/json
{
  • "body": {
    },
  • "code": "string",
  • "message": "string"
}

// 获取我的评论

// 获取我的评论

Request Body schema: application/json
required
content_type
string
cursor
string
limit
int64

Responses

Request samples

Content type
application/json
{
  • "content_type": "string",
  • "cursor": "string",
  • "limit": null
}

Response samples

Content type
application/json
{
  • "body": {
    },
  • "code": "string",
  • "message": "string"
}

CompanionApis

// 上传发帖媒体

// 上传发帖媒体

Request Body schema: application/json
required
client_md5
string

// 客户端文件摘要

content_type
string

// 原始内容类型,由 multipart 文件头回填

file
string <binary>

// 上传文件内容,由 multipart 解析后回填

file_name
string

// 原始文件名,由 multipart 文件头回填

media_type
string

// 媒体类型

usage_scene
string

// 使用场景

Responses

Request samples

Content type
application/json
{
  • "client_md5": "string",
  • "content_type": "string",
  • "file": "string",
  • "file_name": "string",
  • "media_type": "string",
  • "usage_scene": "string"
}

Response samples

Content type
application/json
{
  • "body": {
    },
  • "code": "string",
  • "message": "string"
}

// 获取我的活动中心

// 获取我的活动中心

Request Body schema: application/json
required
cursor
string

// 分页游标

limit
int64

// 分页大小

tab
string
Enum: "CompanionDashboardTabEnum_CompanionDashboardTabEnum_Invalid" "CompanionDashboardTabEnum_CompanionDashboardTabEnum_Landing" "CompanionDashboardTabEnum_CompanionDashboardTabEnum_Waiting" "CompanionDashboardTabEnum_CompanionDashboardTabEnum_Applying" "CompanionDashboardTabEnum_CompanionDashboardTabEnum_Watching" "CompanionDashboardTabEnum_CompanionDashboardTabEnum_Finished"

// tab

Responses

Request samples

Content type
application/json
{
  • "cursor": "string",
  • "limit": null,
  • "tab": "CompanionDashboardTabEnum_CompanionDashboardTabEnum_Invalid"
}

Response samples

Content type
application/json
{
  • "body": {
    },
  • "code": "string",
  • "message": "string"
}

// 获取我的参与列表

// 获取我的参与列表

Request Body schema: application/json
required
cursor
string

// 分页游标

limit
int64

// 分页大小

status
string
Enum: "CompanionParticipationStatusEnum_CompanionParticipationStatusEnum_Invalid" "CompanionParticipationStatusEnum_CompanionParticipationStatusEnum_Watching" "CompanionParticipationStatusEnum_CompanionParticipationStatusEnum_Applying" "CompanionParticipationStatusEnum_CompanionParticipationStatusEnum_Rejected" "CompanionParticipationStatusEnum_CompanionParticipationStatusEnum_ReadyToStart" "CompanionParticipationStatusEnum_CompanionParticipationStatusEnum_InProgress" "CompanionParticipationStatusEnum_CompanionParticipationStatusEnum_PendingReview" "CompanionParticipationStatusEnum_CompanionParticipationStatusEnum_Finished"

// 状态过滤

Responses

Request samples

Content type
application/json
{
  • "cursor": "string",
  • "limit": null,
  • "status": "CompanionParticipationStatusEnum_CompanionParticipationStatusEnum_Invalid"
}

Response samples

Content type
application/json
{
  • "body": {
    },
  • "code": "string",
  • "message": "string"
}

// 获取可评价活动列表

// 获取可评价活动列表

Request Body schema: application/json
required
cursor
string

// 分页游标

limit
int64

// 分页大小

Responses

Request samples

Content type
application/json
{
  • "cursor": "string",
  • "limit": null
}

Response samples

Content type
application/json
{
  • "body": {
    },
  • "code": "string",
  • "message": "string"
}

// 获取招募帖子列表

// 获取招募帖子列表

Request Body schema: application/json
required
cursor
string

// 分页游标

limit
int64

// 分页大小

location
string

// 地点过滤

recruit_status
string
Enum: "CompanionRecruitStatusEnum_CompanionRecruitStatusEnum_Invalid" "CompanionRecruitStatusEnum_CompanionRecruitStatusEnum_Recruiting" "CompanionRecruitStatusEnum_CompanionRecruitStatusEnum_RecruitCompleted" "CompanionRecruitStatusEnum_CompanionRecruitStatusEnum_Closed"

// 招募状态过滤

tags
Array of strings

// 标签过滤

object (locus.models.params.common.companion.CompanionTimeRange)

Responses

Request samples

Content type
application/json
{
  • "cursor": "string",
  • "limit": null,
  • "location": "string",
  • "recruit_status": "CompanionRecruitStatusEnum_CompanionRecruitStatusEnum_Invalid",
  • "tags": [
    ],
  • "time_range": {
    }
}

Response samples

Content type
application/json
{
  • "body": {
    },
  • "code": "string",
  • "message": "string"
}

// 创建招募帖子

// 创建招募帖子

Request Body schema: application/json
required
idempotency_token
string

// 幂等 token

object (locus.models.params.common.companion.CompanionPostComposerPayload)

Responses

Request samples

Content type
application/json
{
  • "idempotency_token": "string",
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "body": {
    },
  • "code": "string",
  • "message": "string"
}

// 获取帖子详情

// 获取帖子详情

Request Body schema: application/json
required
post_id
required
string

// 帖子ID

Responses

Request samples

Content type
application/json
{
  • "post_id": "string"
}

Response samples

Content type
application/json
{
  • "body": {
    },
  • "code": "string",
  • "message": "string"
}

// 编辑招募帖子

// 编辑招募帖子

Request Body schema: application/json
required
object (locus.models.params.common.companion.CompanionPostComposerPayload)
post_id
required
string

// 帖子ID

Responses

Request samples

Content type
application/json
{
  • "payload": {
    },
  • "post_id": "string"
}

Response samples

Content type
application/json
{
  • "body": {
    },
  • "code": "string",
  • "message": "string"
}

// 获取我的申请状态

// 获取我的申请状态

Request Body schema: application/json
required
post_id
required
string

// 帖子ID

Responses

Request samples

Content type
application/json
{
  • "post_id": "string"
}

Response samples

Content type
application/json
{
  • "body": {
    },
  • "code": "string",
  • "message": "string"
}

// 申请状态变更

// 申请状态变更

Request Body schema: application/json
required
action
required
string
Enum: "CompanionApplyActionEnum_CompanionApplyActionEnum_Invalid" "CompanionApplyActionEnum_CompanionApplyActionEnum_Apply" "CompanionApplyActionEnum_CompanionApplyActionEnum_CancelApply" "CompanionApplyActionEnum_CompanionApplyActionEnum_ApplyLeave"

// 申请动作

confirm_notice_read
bool

// 是否确认已读平台须知

post_id
required
string

// 帖子ID

Responses

Request samples

Content type
application/json
{
  • "action": "CompanionApplyActionEnum_CompanionApplyActionEnum_Invalid",
  • "confirm_notice_read": null,
  • "post_id": "string"
}

Response samples

Content type
application/json
{
  • "body": {
    },
  • "code": "string",
  • "message": "string"
}

// 招募审核

// 招募审核

Request Body schema: application/json
required
application_id
required
string

// 申请ID

decision
required
string
Enum: "CompanionReviewDecisionEnum_CompanionReviewDecisionEnum_Invalid" "CompanionReviewDecisionEnum_CompanionReviewDecisionEnum_Approve" "CompanionReviewDecisionEnum_CompanionReviewDecisionEnum_Reject"

// 审核结论

post_id
required
string

// 帖子ID

reason
string

// 审核理由

Responses

Request samples

Content type
application/json
{
  • "application_id": "string",
  • "decision": "CompanionReviewDecisionEnum_CompanionReviewDecisionEnum_Invalid",
  • "post_id": "string",
  • "reason": "string"
}

Response samples

Content type
application/json
{
  • "body": {
    },
  • "code": "string",
  • "message": "string"
}

// 获取申请预览

// 获取申请预览

Request Body schema: application/json
required
post_id
required
string

// 帖子ID

Responses

Request samples

Content type
application/json
{
  • "post_id": "string"
}

Response samples

Content type
application/json
{
  • "body": {
    },
  • "code": "string",
  • "message": "string"
}

// 获取评论列表

// 获取评论列表

Request Body schema: application/json
required
cursor
string

// 分页游标

limit
int64

// 分页大小

post_id
required
string

// 帖子ID

Responses

Request samples

Content type
application/json
{
  • "cursor": "string",
  • "limit": null,
  • "post_id": "string"
}

Response samples

Content type
application/json
{
  • "body": {
    },
  • "code": "string",
  • "message": "string"
}

// 切换收藏

// 切换收藏

Request Body schema: application/json
required
folder_id
string

// 收藏夹ID(为空时返回可选收藏夹)

post_id
required
string

// 帖子ID

Responses

Request samples

Content type
application/json
{
  • "folder_id": "string",
  • "post_id": "string"
}

Response samples

Content type
application/json
{
  • "body": {
    },
  • "code": "string",
  • "message": "string"
}

// 切换点赞

// 切换点赞

Request Body schema: application/json
required
post_id
required
string

// 帖子ID

Responses

Request samples

Content type
application/json
{
  • "post_id": "string"
}

Response samples

Content type
application/json
{
  • "body": {
    },
  • "code": "string",
  • "message": "string"
}

// 获取招募队列

// 获取招募队列

Request Body schema: application/json
required
post_id
required
string

// 帖子ID

Responses

Request samples

Content type
application/json
{
  • "post_id": "string"
}

Response samples

Content type
application/json
{
  • "body": {
    },
  • "code": "string",
  • "message": "string"
}

// 关闭报名入口

// 关闭报名入口

Request Body schema: application/json
required
post_id
required
string

// 帖子ID

Responses

Request samples

Content type
application/json
{
  • "post_id": "string"
}

Response samples

Content type
application/json
{
  • "body": {
    },
  • "code": "string",
  • "message": "string"
}

// 获取我的评价面板

// 获取我的评价面板

Request Body schema: application/json
required
post_id
required
string

// 帖子ID

Responses

Request samples

Content type
application/json
{
  • "post_id": "string"
}

Response samples

Content type
application/json
{
  • "body": {
    },
  • "code": "string",
  • "message": "string"
}

// 参与者评价组织者

// 参与者评价组织者

Request Body schema: application/json
required
operate_type
required
string
Enum: "CompanionFeedbackOperateEnum_CompanionFeedbackOperateEnum_Invalid" "CompanionFeedbackOperateEnum_CompanionFeedbackOperateEnum_Submit" "CompanionFeedbackOperateEnum_CompanionFeedbackOperateEnum_Revoke"

// 操作类型

post_id
required
string

// 帖子ID

score
int64

// 分数

star_level
int64

// 星级

Array of objects (locus.models.params.api.companion.CompanionApiFeedbackTagActionInput)

// 标签动作

Responses

Request samples

Content type
application/json
{
  • "operate_type": "CompanionFeedbackOperateEnum_CompanionFeedbackOperateEnum_Invalid",
  • "post_id": "string",
  • "score": null,
  • "star_level": null,
  • "tag_actions": [
    ]
}

Response samples

Content type
application/json
{
  • "body": {
    },
  • "code": "string",
  • "message": "string"
}

// 组织者查看参与者评价列表

// 组织者查看参与者评价列表

Request Body schema: application/json
required
post_id
required
string

// 帖子ID

scope
string
Enum: "CompanionFeedbackListScopeEnum_CompanionFeedbackListScopeEnum_Invalid" "CompanionFeedbackListScopeEnum_CompanionFeedbackListScopeEnum_Open" "CompanionFeedbackListScopeEnum_CompanionFeedbackListScopeEnum_All"

// 列表范围

Responses

Request samples

Content type
application/json
{
  • "post_id": "string",
  • "scope": "CompanionFeedbackListScopeEnum_CompanionFeedbackListScopeEnum_Invalid"
}

Response samples

Content type
application/json
{
  • "body": {
    },
  • "code": "string",
  • "message": "string"
}

// 组织者评价参与者

// 组织者评价参与者

Request Body schema: application/json
required
operate_type
required
string
Enum: "CompanionFeedbackOperateEnum_CompanionFeedbackOperateEnum_Invalid" "CompanionFeedbackOperateEnum_CompanionFeedbackOperateEnum_Submit" "CompanionFeedbackOperateEnum_CompanionFeedbackOperateEnum_Revoke"

// 操作类型

participant_user_id
required
string

// 参与者用户ID

post_id
required
string

// 帖子ID

star_level
int64

// 星级

Array of objects (locus.models.params.api.companion.CompanionApiFeedbackTagActionInput)

// 标签动作

Responses

Request samples

Content type
application/json
{
  • "operate_type": "CompanionFeedbackOperateEnum_CompanionFeedbackOperateEnum_Invalid",
  • "participant_user_id": "string",
  • "post_id": "string",
  • "star_level": null,
  • "tag_actions": [
    ]
}

Response samples

Content type
application/json
{
  • "body": {
    },
  • "code": "string",
  • "message": "string"
}

// 参与者评价活动

// 参与者评价活动

Request Body schema: application/json
required
operate_type
required
string
Enum: "CompanionFeedbackOperateEnum_CompanionFeedbackOperateEnum_Invalid" "CompanionFeedbackOperateEnum_CompanionFeedbackOperateEnum_Submit" "CompanionFeedbackOperateEnum_CompanionFeedbackOperateEnum_Revoke"

// 操作类型

post_id
required
string

// 帖子ID

score
int64

// 分数

star_level
int64

// 星级

Array of objects (locus.models.params.api.companion.CompanionApiFeedbackTagActionInput)

// 标签动作

Responses

Request samples

Content type
application/json
{
  • "operate_type": "CompanionFeedbackOperateEnum_CompanionFeedbackOperateEnum_Invalid",
  • "post_id": "string",
  • "score": null,
  • "star_level": null,
  • "tag_actions": [
    ]
}

Response samples

Content type
application/json
{
  • "body": {
    },
  • "code": "string",
  • "message": "string"
}

PostApis

// 上传发布媒体

// 上传发布媒体

Request Body schema: application/json
required
client_md5
string

// 客户端文件摘要

content_type
string

// 原始内容类型,由 multipart 文件头回填

file
string <binary>

// 上传文件内容,由 multipart 解析后回填

file_name
string

// 原始文件名,由 multipart 文件头回填

media_type
string

// 媒体类型

Responses

Request samples

Content type
application/json
{
  • "client_md5": "string",
  • "content_type": "string",
  • "file": "string",
  • "file_name": "string",
  • "media_type": "string"
}

Response samples

Content type
application/json
{
  • "body": {
    },
  • "code": "string",
  • "message": "string"
}

// 保存当前草稿

// 保存当前草稿

Request Body schema: application/json
required
base_version
int64

// 基准版本

object (locus.models.params.common.post.PostComposerPayload)
template_type
string

// 模板类型

Responses

Request samples

Content type
application/json
{
  • "base_version": null,
  • "payload": {
    },
  • "template_type": "string"
}

Response samples

Content type
application/json
{
  • "body": {
    },
  • "code": "string",
  • "message": "string"
}

// 获取当前草稿

// 获取当前草稿

Request Body schema: application/json
required
template_type
string

// 模板类型

Responses

Request samples

Content type
application/json
{
  • "template_type": "string"
}

Response samples

Content type
application/json
{
  • "body": {
    },
  • "code": "string",
  • "message": "string"
}

// 获取 marketing 推荐 feed

// 获取 marketing 推荐 feed

Request Body schema: application/json
required
cursor
string

// 分页游标

limit
int64

// 分页大小

Responses

Request samples

Content type
application/json
{
  • "cursor": "string",
  • "limit": null
}

Response samples

Content type
application/json
{
  • "body": {
    },
  • "code": "string",
  • "message": "string"
}

// 发布帖子

// 发布帖子

Request Body schema: application/json
required
discard_active_draft
bool

// 是否丢弃当前激活草稿

draft_id
string

// 草稿ID

idempotency_token
string

// 幂等token

object (locus.models.params.common.post.PostComposerPayload)

Responses

Request samples

Content type
application/json
{
  • "discard_active_draft": null,
  • "draft_id": "string",
  • "idempotency_token": "string",
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "body": {
    },
  • "code": "string",
  • "message": "string"
}

// 获取帖子详情

// 获取帖子详情

Request Body schema: application/json
required
post_id
required
string

// 帖子ID

topic_id
string

// 话题ID

Responses

Request samples

Content type
application/json
{
  • "post_id": "string",
  • "topic_id": "string"
}

Response samples

Content type
application/json
{
  • "body": {
    },
  • "code": "string",
  • "message": "string"
}

// 切换帖子点赞

// 切换帖子点赞

Request Body schema: application/json
required
post_id
required
string

// 帖子ID

Responses

Request samples

Content type
application/json
{
  • "post_id": "string"
}

Response samples

Content type
application/json
{
  • "body": {
    },
  • "code": "string",
  • "message": "string"
}

// 搜索内容

// 搜索内容

Request Body schema: application/json
required
author_user_id
string
cursor
string
keyword
string
limit
int64

Responses

Request samples

Content type
application/json
{
  • "author_user_id": "string",
  • "cursor": "string",
  • "keyword": "string",
  • "limit": null
}

Response samples

Content type
application/json
{
  • "body": {
    },
  • "code": "string",
  • "message": "string"
}

// 获取发布模板

// 获取发布模板

Request Body schema: application/json
required
template_type
string

// 模板类型

Responses

Request samples

Content type
application/json
{
  • "template_type": "string"
}

Response samples

Content type
application/json
{
  • "body": {
    },
  • "code": "string",
  • "message": "string"
}

// 获取用户可见帖子列表

// 获取用户可见帖子列表

Request Body schema: application/json
required
cursor
string

// 分页游标

limit
int64

// 分页大小

topic_id
string

// 话题ID

user_id
required
string

// 用户ID

visibility
string

// 可见性

Responses

Request samples

Content type
application/json
{
  • "cursor": "string",
  • "limit": null,
  • "topic_id": "string",
  • "user_id": "string",
  • "visibility": "string"
}

Response samples

Content type
application/json
{
  • "body": {
    },
  • "code": "string",
  • "message": "string"
}

RecommendApis

/api/recommend/v1/events

Request Body schema: application/json
required
Array of objects (locus.models.domain.recommend.RecommendEvent)

Responses

Request samples

Content type
application/json
{
  • "events": [
    ]
}

Response samples

Content type
application/json
{
  • "body": {
    },
  • "code": "string",
  • "message": "string"
}

UsersApis

// 关注用户

// 关注用户

Request Body schema: application/json
required
follow_id
string
user_id
string

Responses

Request samples

Content type
application/json
{
  • "follow_id": "string",
  • "user_id": "string"
}

Response samples

Content type
application/json
{
  • "body": { },
  • "code": "string",
  • "message": "string"
}

// 取关用户

// 取关用户

Request Body schema: application/json
required
unfollow_id
string

// 取关id

user_id
string

// 用户ID

Responses

Request samples

Content type
application/json
{
  • "unfollow_id": "string",
  • "user_id": "string"
}

Response samples

Content type
application/json
{
  • "body": { },
  • "code": "string",
  • "message": "string"
}

// 微信登录

// 微信登录

Request Body schema: application/json
required
code
string

Responses

Request samples

Content type
application/json
{
  • "code": "string"
}

Response samples

Content type
application/json
{
  • "body": {
    },
  • "code": "string",
  • "message": "string"
}

// 获取收藏夹

// 获取收藏夹

Request Body schema: application/json
required
object (locus.models.params.api.users.GetFavoriteFoldersRequest)

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "body": {
    },
  • "code": "string",
  • "message": "string"
}

// 创建收藏夹

// 创建收藏夹

Request Body schema: application/json
required
folder_name
string

Responses

Request samples

Content type
application/json
{
  • "folder_name": "string"
}

Response samples

Content type
application/json
{
  • "body": {
    },
  • "code": "string",
  • "message": "string"
}

// 删除收藏夹

// 删除收藏夹

Request Body schema: application/json
required
folder_id
string

Responses

Request samples

Content type
application/json
{
  • "folder_id": "string"
}

Response samples

Content type
application/json
{
  • "body": {
    },
  • "code": "string",
  • "message": "string"
}

// 获取收藏夹条目列表

// 获取收藏夹条目列表

Request Body schema: application/json
required
cursor
string
folder_id
string
limit
int64

Responses

Request samples

Content type
application/json
{
  • "cursor": "string",
  • "folder_id": "string",
  • "limit": null
}

Response samples

Content type
application/json
{
  • "body": {
    },
  • "code": "string",
  • "message": "string"
}

// 重命名收藏夹

// 重命名收藏夹

Request Body schema: application/json
required
folder_id
string
folder_name
string

Responses

Request samples

Content type
application/json
{
  • "folder_id": "string",
  • "folder_name": "string"
}

Response samples

Content type
application/json
{
  • "body": {
    },
  • "code": "string",
  • "message": "string"
}

// 收藏内容或活动

// 收藏内容或活动

Request Body schema: application/json
required
folder_id
string
target_id
string
target_type
string

Responses

Request samples

Content type
application/json
{
  • "folder_id": "string",
  • "target_id": "string",
  • "target_type": "string"
}

Response samples

Content type
application/json
{
  • "body": {
    },
  • "code": "string",
  • "message": "string"
}

// 删除收藏条目

// 删除收藏条目

Request Body schema: application/json
required
folder_id
string
target_id
string
target_type
string

Responses

Request samples

Content type
application/json
{
  • "folder_id": "string",
  • "target_id": "string",
  • "target_type": "string"
}

Response samples

Content type
application/json
{
  • "body": {
    },
  • "code": "string",
  • "message": "string"
}

// 移动收藏条目

// 移动收藏条目

Request Body schema: application/json
required
source_folder_id
string
target_folder_id
string
target_id
string
target_type
string

Responses

Request samples

Content type
application/json
{
  • "source_folder_id": "string",
  • "target_folder_id": "string",
  • "target_id": "string",
  • "target_type": "string"
}

Response samples

Content type
application/json
{
  • "body": {
    },
  • "code": "string",
  • "message": "string"
}

// 获取互关用户列表

// 获取互关用户列表

Request Body schema: application/json
required
cursor
string
keyword
string
limit
int64

Responses

Request samples

Content type
application/json
{
  • "cursor": "string",
  • "keyword": "string",
  • "limit": null
}

Response samples

Content type
application/json
{
  • "body": {
    },
  • "code": "string",
  • "message": "string"
}

// 获取关注时间线

// 获取关注时间线

Request Body schema: application/json
required
cursor
string
limit
int64

Responses

Request samples

Content type
application/json
{
  • "cursor": "string",
  • "limit": null
}

Response samples

Content type
application/json
{
  • "body": {
    },
  • "code": "string",
  • "message": "string"
}

// 用户基础信息

// 用户基础信息

Request Body schema: application/json
required
user_id
string

Responses

Request samples

Content type
application/json
{
  • "user_id": "string"
}

Response samples

Content type
application/json
{
  • "body": {
    },
  • "code": "string",
  • "message": "string"
}

// 创建用户

// 创建用户

Request Body schema: application/json
required
avatar
string

// 头像

birth_time
string

// 生日

create_by
string
Enum: "UserCreateMethodEnum_UserCreateMethodEnum_Invalid" "UserCreateMethodEnum_UserCreateMethodEnum_ByPhone" "UserCreateMethodEnum_UserCreateMethodEnum_ByWechat"

// 创建场景

gender
string

// 性别

location
string

// 所在城市

passport
string

// 验证码

object (locus.models.params.common.users.CreateUserScene)
ticket
string

// 创建凭证,手机号或者微信openid

Responses

Request samples

Content type
application/json
{
  • "avatar": "string",
  • "birth_time": "string",
  • "create_by": "UserCreateMethodEnum_UserCreateMethodEnum_Invalid",
  • "gender": "string",
  • "location": "string",
  • "passport": "string",
  • "scene": {
    },
  • "ticket": "string"
}

Response samples

Content type
application/json
{
  • "body": {
    },
  • "code": "string",
  • "message": "string"
}

// 用户编辑

// 用户编辑

Request Body schema: application/json
required
avatar
string

// 头像

desc
string

// 个性签名

gender
string
Enum: "UserGenderEnum_UserGenderEnum_Invalid" "UserGenderEnum_UserGenderEnum_Male" "UserGenderEnum_UserGenderEnum_Female"

// 性别

location
string

// 所在城市

nickname
required
string

// 昵称

Responses

Request samples

Content type
application/json
{
  • "avatar": "string",
  • "desc": "string",
  • "gender": "UserGenderEnum_UserGenderEnum_Invalid",
  • "location": "string",
  • "nickname": "string"
}

Response samples

Content type
application/json
{
  • "body": {
    },
  • "code": "string",
  • "message": "string"
}

// 设置搭子足迹展示开关

// 设置搭子足迹展示开关

Request Body schema: application/json
required
visible
bool

Responses

Request samples

Content type
application/json
{
  • "visible": null
}

Response samples

Content type
application/json
{
  • "body": {
    },
  • "code": "string",
  • "message": "string"
}

// 获取搭子足迹列表

// 获取搭子足迹列表

Request Body schema: application/json
required
cursor
string
limit
int64
user_id
string

Responses

Request samples

Content type
application/json
{
  • "cursor": "string",
  • "limit": null,
  • "user_id": "string"
}

Response samples

Content type
application/json
{
  • "body": {
    },
  • "code": "string",
  • "message": "string"
}

// 用户详细信息

// 用户详细信息

Request Body schema: application/json
required
user_id
string

Responses

Request samples

Content type
application/json
{
  • "user_id": "string"
}

Response samples

Content type
application/json
{
  • "body": {
    },
  • "code": "string",
  • "message": "string"
}

// 获取推荐队长列表

// 获取推荐队长列表

Request Body schema: application/json
required
limit
int64

Responses

Request samples

Content type
application/json
{
  • "limit": null
}

Response samples

Content type
application/json
{
  • "body": {
    },
  • "code": "string",
  • "message": "string"
}

// 搜索用户

// 搜索用户

Request Body schema: application/json
required
cursor
string
keyword
string
limit
int64

Responses

Request samples

Content type
application/json
{
  • "cursor": "string",
  • "keyword": "string",
  • "limit": null
}

Response samples

Content type
application/json
{
  • "body": {
    },
  • "code": "string",
  • "message": "string"
}

// 主页共同心动目的地提醒

// 主页共同心动目的地提醒

Request Body schema: application/json
required
target_user_id
string

Responses

Request samples

Content type
application/json
{
  • "target_user_id": "string"
}

Response samples

Content type
application/json
{
  • "body": {
    },
  • "code": "string",
  • "message": "string"
}

ZoneApis

// 获取去哪儿信息

// 获取去哪儿信息

Request Body schema: application/json
required
userId
string

Responses

Request samples

Content type
application/json
{
  • "userId": "string"
}

Response samples

Content type
application/json
{
  • "body": {
    },
  • "code": "string",
  • "message": "string"
}

// 设置去哪儿的信息

// 设置去哪儿的信息

Request Body schema: application/json
required
name
Array of strings
userId
string

Responses

Request samples

Content type
application/json
{
  • "name": [
    ],
  • "userId": "string"
}

Response samples

Content type
application/json
{
  • "body": { },
  • "code": "string",
  • "message": "string"
}