PokeForum API
  1. Health Check | 健康检查
PokeForum API
  • Health Check | 健康检查
    • Detailed health check | 详细健康检查
      GET
    • Liveness probe | 存活检测
      GET
    • Readiness check | 就绪检查
      GET
  • OAuth | OAuth登录
    • Get enabled OAuth providers list | 获取已启用的OAuth提供商列表
      GET
    • Get OAuth authorization URL | 获取OAuth授权URL
      GET
    • Handle OAuth callback | 处理OAuth回调
      POST
  • Authentication | 认证
    • Send forgot password verification code | 发送找回密码验证码
      POST
    • User login | 用户登录
      POST
    • User logout | 用户退出登录
      POST
    • User registration | 用户注册
      POST
    • Reset password | 重置密码
      POST
  • Public Configuration | 公开配置
    • Get public configuration | 获取公开配置
      GET
  • [User]Profile | [用户]个人中心
    • Get user profile overview | 获取用户个人中心概览
      GET
    • Update avatar | 修改头像
      PUT
    • Get user comments list | 获取用户评论列表
      GET
    • Verify email | 验证邮箱
      POST
    • Send email verification code | 发送邮箱验证码
      POST
    • Get user favorites list | 获取用户收藏列表
      GET
    • Update password | 修改密码
      PUT
    • Get user posts list | 获取用户主题帖列表
      GET
    • Update username | 修改用户名
      PUT
  • [User]OAuth | [用户]OAuth登录
    • Get user OAuth binding list | 获取用户OAuth绑定列表
      GET
    • Unbind OAuth account | 解绑OAuth账号
      DELETE
    • Handle OAuth bind callback | 处理OAuth绑定回调
      POST
    • Get OAuth bind authorization URL | 获取OAuth绑定授权URL
      GET
  • [User]Category | [用户]版块
    • Get category list | 获取版块列表
  • [User]Comments | [用户]评论
    • Get comment list | 获取评论列表
    • Update comment | 更新评论
    • Create comment | 创建评论
    • Dislike comment | 点踩评论
    • Like comment | 点赞评论
  • [User]Topic Posts | [用户]主题贴
    • Get post list | 获取帖子列表
    • Edit post | 编辑帖子
    • Publish new post | 发布新帖
    • Dislike post | 点踩帖子
    • Get draft list | 获取草稿列表
    • Save draft | 保存草稿
    • Delete draft | 删除草稿
    • Favorite post | 收藏帖子
    • Like post | 点赞帖子
    • Set post as private | 设置帖子私有
    • Get post detail | 获取帖子详情
  • [User]Ranking | [用户]排行榜
    • 获取评论数排行榜
    • 获取财富榜
    • 获取名人榜
    • 获取积分榜
    • 获取帖子数排行榜
    • 获取阅读排行榜
  • [User]Sign-in | [用户]签到
    • Perform sign-in | 执行签到
    • Get continuous sign-in ranking | 获取连续签到排行榜
    • Get daily sign-in ranking | 获取每日签到排行榜
    • Get sign-in status | 获取签到状态
  • [User]Discovery | [用户]发现
    • Get interactive comments | 获取互动评论
    • Get latest discussions | 获取最新讨论
    • Get fresh posts | 获取新鲜发布的帖子
  • [User]Invitation Code | [用户]邀请码
    • Generate invitation code | 生成邀请码
    • Get my invitation codes | 获取我的邀请码列表
  • [User]Blacklist Management | [用户]黑名单管理
    • Add user to blacklist | 添加用户到黑名单
    • Get user blacklist list | 获取用户黑名单列表
    • Remove user from blacklist | 从黑名单移除用户
  • [User] User Follow | [用户个人中心] 用户关注
    • Follow user | 关注用户
    • Get user followers list | 获取用户粉丝列表
    • Get user following list | 获取用户关注列表
    • Get follow status | 获取关注状态
    • Unfollow user | 取消关注用户
  • [User]Report | [用户]举报
    • Create report | 创建举报
    • Get my reports | 获取我的举报列表
  • [Moderator]Category Management | [版主]版块管理
    • Get list of categories managed by moderator | 获取版主管理的版块列表
    • Edit category | 编辑版块
    • Create category announcement | 创建版块公告
    • Get category announcement list | 获取版块公告列表
    • Edit post | 编辑帖子
    • Ban post | 封禁帖子
    • Set post essence | 设置帖子精华
    • Lock post | 锁定帖子
    • Move post | 移动帖子
    • Pin post | 置顶帖子
  • [Admin]Dashboard | [管理员]仪表盘
    • Get dashboard statistics | 获取仪表盘统计数据
    • Get recent activity | 获取最近活动
    • Get popular categories | 获取热门版块
    • Get popular posts | 获取热门帖子
  • [Admin]Category Management | [管理员]版块管理
    • Get category list | 获取版块列表
    • Update category information | 更新版块信息
    • Create category | 创建版块
    • Set category moderators | 设置版块版主
    • Update category status | 更新版块状态
    • Get category details | 获取版块详情
    • Delete category | 删除版块
  • [Admin]Comment Management | [管理员]评论管理
    • Get comment list | 获取评论列表
    • Update comment information | 更新评论信息
    • Create comment | 创建评论
    • Set comment as pinned | 设置评论置顶
    • Set comment as featured | 设置评论精选
    • Get comment detail | 获取评论详情
    • Delete comment | 删除评论
  • [Admin]Post Management | [管理员]主题贴管理
    • Get post list | 获取帖子列表
    • Update post information | 更新帖子信息
    • Set post as featured | 设置帖子精华
    • Move post | 移动帖子
    • Set post as pinned | 设置帖子置顶
    • Update post status | 更新帖子状态
    • Get post detail | 获取帖子详情
    • Delete post | 删除帖子
  • [Admin]User Management | [管理员]用户管理
    • Get user list | 获取用户列表
    • Update user information | 更新用户信息
    • Create user | 创建用户
    • Get user balance change logs | 获取用户余额变动记录
    • Get user balance summary information | 获取用户余额汇总信息
    • Ban user | 封禁用户
    • Update user currency | 更新用户货币
    • Set moderator categories | 设置版主管理版块
    • Update user points | 更新用户积分
    • Update user role | 更新用户身份
    • Update user status | 更新用户状态
    • Unban user | 解封用户
    • Get user details | 获取用户详情
  • [Admin]Invitation Code Management | [管理员]邀请码管理
    • Get invitation code list | 获取邀请码列表
    • Update invitation code information | 更新邀请码信息
    • Create invitation code | 创建邀请码
    • Get invitation code statistics | 获取邀请码统计信息
    • Update invitation code status | 更新邀请码状态
    • Get invitation code details | 获取邀请码详情
    • Delete invitation code | 删除邀请码
  • [Admin]Report Management | [管理员]举报管理
    • Batch handle reports | 批量处理举报
    • Handle report | 处理举报
    • Get report list | 获取举报列表
    • Get report statistics | 获取举报统计
  • [Super Admin]System Settings | [超级管理员]系统设置
    • Get code configuration | 获取代码配置
    • Update code configuration | 更新代码配置
    • Get comment settings | 获取评论设置
    • Update comment settings | 更新评论设置
    • Get email settings | 获取邮箱设置
    • Update email settings | 更新邮箱设置
    • Send test email | 发送测试邮件
    • Get home settings | 获取首页设置
    • Update home settings | 更新首页设置
    • Get routine settings | 获取常规设置
    • Update routine settings | 更新常规设置
    • Get security settings | 获取安全设置
    • Update security settings | 更新安全设置
    • Get SEO settings | 获取SEO设置
    • Update SEO settings | 更新SEO设置
    • Get sign-in settings | 获取签到设置
    • Update sign-in settings | 更新签到设置
    • Get invitation code settings | 获取邀请码设置
    • Update invitation code settings | 更新邀请码设置
  • [Super Admin]OAuth Provider Management | [超级管理员]OAuth提供商管理
    • Get OAuth provider list | 获取OAuth提供商列表
    • Update OAuth provider information | 更新OAuth提供商信息
    • Create OAuth provider | 创建OAuth提供商
    • Update OAuth provider status | 更新OAuth提供商状态
    • Get OAuth provider details | 获取OAuth提供商详情
    • Delete OAuth provider | 删除OAuth提供商
  • 数据模型
    • response.Data
    • response.ResCode
    • schema.EmailSMTPConfigRequest
    • schema.CategoryAnnouncementRequest
    • schema.CategoryBasicInfo
    • schema.LoginRequest
    • schema.EmailSMTPConfigResponse
    • schema.CategoryAnnouncementResponse
    • schema.CodeSettingsRequest
    • schema.LoginResponse
    • schema.CategoryCreateRequest
    • schema.EmailTestRequest
    • schema.CodeSettingsResponse
    • schema.RegisterRequest
    • schema.CategoryDetailResponse
    • schema.EmailTestResponse
    • schema.CommentSettingsRequest
    • schema.UserResponse
    • schema.CategoryListItem
    • schema.CommentSettingsResponse
    • schema.CategoryListResponse
    • schema.CategoryEditRequest
    • schema.CategoryModeratorRequest
    • schema.CategoryStatusUpdateRequest
    • schema.CategoryUpdateRequest
    • schema.CategoryStats
    • schema.HomeSettingsRequest
    • schema.HomeSettingsResponse
    • schema.LinkItem
    • schema.Check
    • schema.CommentCreateRequest
    • schema.ModeratorCategoryRequest
    • schema.CommentDetailResponse
    • schema.CommentCountRankingItem
    • schema.CommentListItem
    • schema.RoutineSettingsRequest
    • schema.CommentCountRankingResponse
    • schema.CommentListResponse
    • schema.RoutineSettingsResponse
    • schema.CommentPinUpdateRequest
    • schema.SafeSettingsRequest
    • schema.CommentSelectedUpdateRequest
    • schema.SafeSettingsResponse
    • schema.SeoSettingsRequest
    • schema.SeoSettingsResponse
    • schema.CommentStats
    • schema.SlideItem
    • schema.CommentUpdateRequest
    • schema.UserBalanceLogItem
    • schema.DashboardStatsResponse
    • schema.UserBalanceLogResponse
    • schema.UserBalanceSummary
    • schema.DiscoveryCommentItem
    • schema.UserCreateRequest
    • schema.DiscoveryCommentsResponse
    • schema.CurrencyRankingItem
    • schema.UserCurrencyUpdateRequest
    • schema.DiscoveryFreshResponse
    • schema.CurrencyRankingResponse
    • schema.UserDetailResponse
    • schema.DiscoveryLatestDiscussionItem
    • schema.UserListItem
    • schema.DiscoveryLatestDiscussionResponse
    • schema.EmailVerifyCodeResponse
    • schema.UserListResponse
    • schema.DiscoveryPostItem
    • schema.EmailVerifyRequest
    • schema.UserPointsUpdateRequest
    • schema.EmailVerifyResponse
    • schema.UserRoleUpdateRequest
    • schema.ForgotPasswordRequest
    • schema.ModeratorCategoriesResponse
    • schema.UserStatusUpdateRequest
    • schema.ForgotPasswordResponse
    • schema.ModeratorCategory
    • schema.UserUpdateRequest
    • schema.HealthStatus
    • schema.ModeratorPostResponse
    • schema.InvitationCodeSettingsRequest
    • schema.NewUser
    • schema.InvitationCodeCreateRequest
    • schema.OAuthProviderCreateRequest
    • schema.InvitationCodeSettingsResponse
    • schema.PopularCategoriesResponse
    • schema.InvitationCodeDetailResponse
    • schema.OAuthProviderDetailResponse
    • schema.PopularCategory
    • schema.InvitationCodeListItem
    • schema.OAuthProviderListItem
    • schema.PopularPost
    • schema.InvitationCodeListResponse
    • schema.OAuthProviderListResponse
    • schema.PopularPostsResponse
    • schema.OAuthProviderStatusUpdateRequest
    • schema.PostBanRequest
    • schema.FollowerRankingItem
    • schema.OAuthProviderUpdateRequest
    • schema.FollowerRankingResponse
    • schema.InvitationCodeStatsResponse
    • schema.PostDetailResponse
    • schema.InvitationCodeStatusUpdateRequest
    • schema.PostEditRequest
    • schema.InvitationCodeUpdateRequest
    • schema.OAuthAuthorizeResponse
    • schema.PostEssenceRequest
    • schema.OAuthBindCallbackRequest
    • schema.PostEssenceUpdateRequest
    • schema.OAuthCallbackRequest
    • schema.PostListItem
    • schema.OAuthCallbackResponse
    • schema.PostListResponse
    • schema.PostLockRequest
    • schema.PostMoveRequest
    • schema.PostPinRequest
    • schema.PostPinUpdateRequest
    • schema.OAuthProviderPublicItem
    • schema.PostStats
    • schema.OAuthProviderPublicListResponse
    • schema.PostStatusUpdateRequest
    • schema.RecentActivityResponse
    • schema.OAuthUserBindItem
    • schema.RecentComment
    • schema.OAuthUserBindListResponse
    • schema.RecentPost
    • schema.PublicConfigResponse
    • schema.SystemStats
    • schema.UserCategoryListItem
    • schema.UserCommentActionRequest
    • schema.UserBlacklistAddRequest
    • schema.UserCategoryResponse
    • schema.UserCommentActionResponse
    • schema.UserBlacklistAddResponse
    • schema.UserCommentCreateRequest
    • schema.SigninRankingItem
    • schema.UserBlacklistItem
    • schema.UserCommentCreateResponse
    • schema.SigninResponse
    • schema.UserBlacklistListResponse
    • schema.SigninResult
    • schema.UserBlacklistRemoveRequest
    • schema.UserCommentListItem
    • schema.SigninSettingsRequest
    • schema.SigninStatus
    • schema.UserBlacklistRemoveResponse
    • schema.UserCommentListResponse
    • schema.SigninSettingsResponse
    • schema.UserCommentUpdateRequest
    • schema.PointsRankingItem
    • schema.UserCommentUpdateResponse
    • schema.PointsRankingResponse
    • schema.PostCountRankingItem
    • schema.UserPostActionRequest
    • schema.PostCountRankingResponse
    • schema.UserPostActionResponse
    • schema.UserPostCreateRequest
    • schema.UserPostCreateResponse
    • schema.UserPostDetailResponse
    • schema.UserPostListResponse
    • schema.UserPostUpdateRequest
    • schema.UserPostUpdateResponse
    • schema.ResetPasswordRequest
    • schema.UserProfileCommentItem
    • schema.ResetPasswordResponse
    • schema.UserProfileCommentsResponse
    • schema.UserProfileFavoriteItem
    • schema.UserProfileFavoritesResponse
    • schema.UserProfileOverviewResponse
    • schema.UserProfilePostItem
    • schema.UserProfilePostsResponse
    • schema.ReadingRankingItem
    • schema.ReadingRankingResponse
    • schema.SigninRankingResponse
    • schema.UserStats
    • schema.UserUpdateAvatarRequest
    • schema.UserUpdateAvatarResponse
    • schema.ReportBatchHandleRequest
    • schema.ReportCreateRequest
    • schema.ReportCreateResponse
    • schema.UserUpdatePasswordRequest
    • schema.ReportHandleRequest
    • schema.UserUpdatePasswordResponse
    • schema.UserBanRequest
    • schema.ReportHandleResponse
    • schema.ReportListItem
    • schema.SystemInfo
    • schema.UserUpdateUsernameRequest
    • schema.ReportListResponse
    • schema.UserUpdateUsernameResponse
    • schema.ReportStatsItem
    • schema.ReportStatsResponse
    • schema.UserFollowItem
    • schema.UserFollowRequest
    • schema.UserFollowResponse
    • schema.UserFollowStatusResponse
    • schema.UserFollowersResponse
    • schema.UserFollowingResponse
    • schema.UserDraftDeleteRequest
    • schema.UserInvitationCodeDetail
    • schema.UserInvitationCodeListData
    • schema.UserInvitationCodeListItem
    • schema.UserUnbanRequest
    • schema.UserUnfollowResponse
    • schema.UserReportItem
    • schema.UserReportListResponse
  1. Health Check | 健康检查

Detailed health check | 详细健康检查

GET
/health
Check health status of all dependent services | 检查所有依赖服务的健康状态

请求参数

Query 参数

请求示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request GET '/health?detail'

返回响应

🟢200
application/json
Service healthy | 服务健康
Body

示例
🔴503
修改于 2026-01-30 03:01:02
下一页
Liveness probe | 存活检测
Built with