v1

Documentation

Index

• type Admin
• type AlipayPriv
• type AlipayPub
• type Core
• type Followship
• type Friendship
• type Loose
• type Priv
• type Pub

Types

type Admin

type Admin struct {
	Chain Chain `mir:"-"`
	Group Group `mir:"v1"`

	// ChangeUserStatus 管理·禁言/解封用户
	ChangeUserStatus func(Post, web.ChangeUserStatusReq) `mir:"/admin/user/status"`
}

Admin 运维相关服务

type AlipayPriv

type AlipayPriv struct {
	Chain Chain `mir:"-"`
	Group Group `mir:"v1"`

	// 	UserRechargeLink 用户充值
	UserRechargeLink func(Post, web.UserRechargeLinkReq) web.UserRechargeLinkResp `mir:"/user/recharge"`

	// UserRechargeResult 获取充值结果
	UserRechargeResult func(Get, web.UserRechargeResultReq) web.UserRechargeResultResp `mir:"/user/recharge"`

	// UserWalletBills 获取用户账单
	UserWalletBills func(Get, web.UserWalletBillsReq) web.UserWalletBillsResp `mir:"/user/wallet/bills"`
}

AlipayPub 支付宝相关授权的服务

type AlipayPub

type AlipayPub struct {
	Group Group `mir:"v1"`

	// AlipayNotify 支付宝回调
	AlipayNotify func(Post, web.AlipayNotifyReq) `mir:"/alipay/notify"`
}

AlipayPub 支付宝相关不用授权的服务

type Core

type Core struct {
	Chain Chain `mir:"-"`
	Group Group `mir:"v1"`

	// SyncSearchIndex 同步索引
	SyncSearchIndex func(Get, web.SyncSearchIndexReq) `mir:"/sync/index"`

	// GetUserInfo 获取当前用户信息
	GetUserInfo func(Get, web.UserInfoReq) web.UserInfoResp `mir:"/user/info"`

	// GetUnreadMsgCount 获取当前用户未读消息数量
	GetUnreadMsgCount func(Get, web.GetUnreadMsgCountReq) web.GetUnreadMsgCountResp `mir:"/user/msgcount/unread"`

	// GetMessages 获取消息列表
	GetMessages func(Get, web.GetMessagesReq) web.GetMessagesResp `mir:"/user/messages"`

	// ReadMessage 标记消息已读
	ReadMessage func(Post, web.ReadMessageReq) `mir:"/user/message/read"`

	// SendUserWhisper 发送用户私信
	SendUserWhisper func(Post, web.SendWhisperReq) `mir:"/user/whisper"`

	// GetCollections 获取用户收藏列表
	GetCollections func(Get, web.GetCollectionsReq) web.GetCollectionsResp `mir:"/user/collections"`

	// GetStars 获取用户点赞列表
	GetStars func(Get, web.GetStarsReq) web.GetStarsResp `mir:"/user/stars"`

	// UserPhoneBind 绑定用户手机号
	UserPhoneBind func(Post, web.UserPhoneBindReq) `mir:"/user/phone"`

	// ChangePassword 修改密码
	ChangePassword func(Post, web.ChangePasswordReq) `mir:"/user/password"`

	// ChangeNickname 修改昵称
	ChangeNickname func(Post, web.ChangeNicknameReq) `mir:"/user/nickname"`

	// ChangeAvatar 修改头像
	ChangeAvatar func(Post, web.ChangeAvatarReq) `mir:"/user/avatar"`

	// SuggestUsers 检索用户
	SuggestUsers func(Get, web.SuggestUsersReq) web.SuggestUsersResp `mir:"/suggest/users"`

	// SuggestTags 检索标签
	SuggestTags func(Get, web.SuggestTagsReq) web.SuggestTagsResp `mir:"/suggest/tags"`

	// TweetStarStatus 获取动态点赞状态
	TweetStarStatus func(Get, web.TweetStarStatusReq) web.TweetStarStatusResp `mir:"/post/star"`

	// TweetCollectionStatus 获取动态收藏状态
	TweetCollectionStatus func(Get, web.TweetCollectionStatusReq) web.TweetCollectionStatusResp `mir:"/post/collection"`
}

Core 核心服务，需要授权访问

type Followship

type Followship struct {
	Chain Chain `mir:"-"`
	Group Group `mir:"v1"`

	// AddFollowing 添加关注
	AddFollowing func(Post, web.AddFollowingReq) `mir:"/following/add"`

	// DeleteFollowing  取消关注
	DeleteFollowing func(Post, web.DeleteFollowingReq) `mir:"/following/delete"`

	// ListFollowings 获取用户的关注列表
	ListFollowings func(Get, web.ListFollowingsReq) web.ListFollowingsResp `mir:"/following/list"`

	// ListFollowers 获取用户的追随者列表
	ListFollowers func(Get, web.ListFollowersReq) web.ListFollowersResp `mir:"/follower/list"`
}

Followship 关注者模式 服务

type Friendship

type Friendship struct {
	Chain Chain `mir:"-"`
	Group Group `mir:"v1"`

	// 	RequestingFriend 请求添加朋友
	RequestingFriend func(Post, web.RequestingFriendReq) `mir:"/friend/requesting"`

	// AddFriend 同意添加好友
	AddFriend func(Post, web.AddFriendReq) `mir:"/friend/add"`

	// RejectFriend 拒绝添加好友
	RejectFriend func(Post, web.RejectFriendReq) `mir:"/friend/reject"`

	// 	DeleteFriend 删除好友
	DeleteFriend func(Post, web.DeleteFriendReq) `mir:"/friend/delete"`

	// GetContacts 获取好友列表
	GetContacts func(Get, web.GetContactsReq) web.GetContactsResp `mir:"/user/contacts"`
}

Friendship 好友模式 服务

type Loose

type Loose struct {
	Chain Chain `mir:"-"`
	Group Group `mir:"v1"`

	// Timeline 获取广场流
	Timeline func(Get, web.TimelineReq) web.TimelineResp `mir:"/posts"`

	// GetUserTweets 获取用户动态列表
	GetUserTweets func(Get, web.GetUserTweetsReq) web.GetUserTweetsResp `mir:"/user/posts"`

	// GetUserProfile 获取用户基本信息
	GetUserProfile func(Get, web.GetUserProfileReq) web.GetUserProfileResp `mir:"/user/profile"`
}

Loose 宽松授权的服务

type Priv

type Priv struct {
	Chain Chain `mir:"-"`
	Group Group `mir:"v1"`

	// UploadAttachment 上传资源
	UploadAttachment func(Post, web.UploadAttachmentReq) web.UploadAttachmentResp `mir:"/attachment"`

	// DownloadAttachmentPrecheck 下载资源预检
	DownloadAttachmentPrecheck func(Get, web.DownloadAttachmentPrecheckReq) web.DownloadAttachmentPrecheckResp `mir:"/attachment/precheck"`

	// DownloadAttachment 下载资源
	DownloadAttachment func(Get, web.DownloadAttachmentReq) web.DownloadAttachmentResp `mir:"/attachment"`

	// CreateTweet 发布动态
	CreateTweet func(Post, web.CreateTweetReq) web.CreateTweetResp `mir:"/post"`

	// DeleteTweet 删除动态
	DeleteTweet func(Delete, web.DeleteTweetReq) `mir:"/post"`

	// StarTweet 动态点赞操作
	StarTweet func(Post, web.StarTweetReq) web.StarTweetResp `mir:"/post/start"`

	// CollectionTweet 动态收藏操作
	CollectionTweet func(Post, web.CollectionTweetReq) web.CollectionTweetResp `mir:"/post/collection"`

	// LockTweet 锁定动态
	LockTweet func(Post, web.LockTweetReq) web.LockTweetResp `mir:"/post/lock"`

	// StickTweet 置顶动态
	StickTweet func(Post, web.StickTweetReq) web.StickTweetResp `mir:"/post/stick"`

	// VisibleTweet 修改动态可见度
	VisibleTweet func(Post, web.VisibleTweetReq) web.VisibleTweetResp `mir:"/post/visibility"`

	// CreateTweetComment 发布动态评论
	CreateComment func(Post, web.CreateCommentReq) web.CreateCommentResp `mir:"/post/comment"`

	// DeletePostComment 删除动态评论
	DeleteComment func(Delete, web.DeleteCommentReq) `mir:"/post/comment"`

	// CreateCommentReply 发布评论回复
	CreateCommentReply func(Post, web.CreateCommentReplyReq) web.CreateCommentReplyResp `mir:"/post/comment/reply"`

	// DeleteCommentReply 删除评论回复
	DeleteCommentReply func(Delete, web.DeleteCommentReplyReq) `mir:"/post/comment/reply"`
}

Priv 私有授权的服务

type Pub

type Pub struct {
	Group Group `mir:"v1"`

	// Version 获取后台版本信息
	Version func(Get) web.VersionResp `mir:"/"`

	// Login 用户登录
	Login func(Post, web.LoginReq) web.LoginResp `mir:"/auth/login"`

	// Register 用户注册
	Register func(Post, web.RegisterReq) web.RegisterResp `mir:"/auth/register"`

	// GetCaptcha 获取验证码
	GetCaptcha func(Get) web.GetCaptchaResp `mir:"/captcha"`

	// SendCaptcha 发送验证码
	SendCaptcha func(Post, web.SendCaptchaReq) `mir:"/captcha"`

	// TweetDetail 获取动态详情
	TweetDetail func(Get, web.TweetDetailReq) web.TweetDetailResp `mir:"/post"`

	// TweetComments 获取动态评论
	TweetComments func(Get, web.TweetCommentsReq) web.TweetCommentsResp `mir:"/post/comments"`

	// TopicList 获取话题列表
	TopicList func(Get, web.TopicListReq) web.TopicListResp `mir:"/tags"`
}

Pub 不用授权的公开服务