OpenIsle Docs
API 概览

# API 概览

Open API 接口文档

# 接口列表

以下列表聚合了所有已生成的接口页面，展示对应的路径、请求方法以及摘要，便于快速检索和跳转。

路径 | 方法 | 摘要
--- | --- | ---
/api/activities | GET | List activities
/api/activities/milk-tea | GET | Milk tea info
/api/activities/milk-tea/redeem | POST | Redeem milk tea
/api/admin/comments/{id}/pin | POST | Pin comment
/api/admin/comments/{id}/unpin | POST | Unpin comment
/api/admin/config | GET | Get configuration
/api/admin/config | POST | Update configuration
/api/admin/hello | GET | Admin greeting
/api/admin/posts/{id}/approve | POST | Approve post
/api/admin/posts/{id}/pin | POST | Pin post
/api/admin/posts/{id}/reject | POST | Reject post
/api/admin/posts/{id}/rss-exclude | POST | Exclude from RSS
/api/admin/posts/{id}/rss-include | POST | Include in RSS
/api/admin/posts/{id}/unpin | POST | Unpin post
/api/admin/posts/pending | GET | List pending posts
/api/admin/tags/{id}/approve | POST | Approve tag
/api/admin/tags/pending | GET | List pending tags
/api/admin/users/{id}/approve | POST | Approve user
/api/admin/users/{id}/reject | POST | Reject user
/api/ai/format | POST | Format markdown
/api/auth/check | GET | Check token
/api/auth/discord | POST | Login with Discord
/api/auth/forgot/reset | POST | Reset password
/api/auth/forgot/send | POST | Send reset code
/api/auth/forgot/verify | POST | Verify reset code
/api/auth/github | POST | Login with GitHub
/api/auth/google | POST | Login with Google
/api/auth/login | POST | Login
/api/auth/reason | POST | Submit register reason
/api/auth/register | POST | Register user
/api/auth/telegram | POST | Login with Telegram
/api/auth/twitter | POST | Login with Twitter
/api/auth/verify | POST | Verify account
/api/categories | GET | List categories
/api/categories | POST | Create category
/api/categories/{id} | DELETE | Delete category
/api/categories/{id} | GET | Get category
/api/categories/{id} | PUT | Update category
/api/categories/{id}/posts | GET | List posts by category
/api/channels | GET | List channels
/api/channels/{channelId}/join | POST | Join channel
/api/channels/unread-count | GET | Unread count
/api/comments/{commentId}/context | GET | Comment context
/api/comments/{commentId}/reactions | POST | React to comment
/api/comments/{commentId}/replies | POST | Reply to comment
/api/comments/{id} | DELETE | Delete comment
/api/comments/{id}/pin | POST | Pin comment
/api/comments/{id}/unpin | POST | Unpin comment
/api/config | GET | Site config
/api/drafts | POST | Save draft
/api/drafts/me | DELETE | Delete my draft
/api/drafts/me | GET | Get my draft
/api/hello | GET | Hello endpoint
/api/invite/generate | POST | Generate invite
/api/medals | GET | List medals
/api/medals/select | POST | Select medal
/api/messages | POST | Send message
/api/messages/{messageId}/reactions | POST | React to message
/api/messages/conversations | GET | List conversations
/api/messages/conversations | POST | Find or create conversation
/api/messages/conversations/{conversationId} | GET | Get conversation
/api/messages/conversations/{conversationId}/messages | POST | Send message to conversation
/api/messages/conversations/{conversationId}/read | POST | Mark conversation read
/api/messages/unread-count | GET | Unread message count
/api/notifications | GET | List notifications
/api/notifications/email-prefs | GET | List email preferences
/api/notifications/email-prefs | POST | Update email preference
/api/notifications/prefs | GET | List preferences
/api/notifications/prefs | POST | Update preference
/api/notifications/read | POST | Mark notifications read
/api/notifications/unread | GET | List unread notifications
/api/notifications/unread-count | GET | Unread count
/api/online/count | GET | Online count
/api/online/heartbeat | POST | Heartbeat
/api/point-goods | GET | List goods
/api/point-goods/redeem | POST | Redeem good
/api/point-histories | GET | Point history
/api/point-histories/trend | GET | Point trend
/api/posts | GET | List posts
/api/posts | POST | Create post
/api/posts/{id} | DELETE | Delete post
/api/posts/{id} | GET | Get post
/api/posts/{id} | PUT | Update post
/api/posts/{id}/change-logs | GET | Post change logs
/api/posts/{id}/close | POST | Close post
/api/posts/{id}/lottery/join | POST | Join lottery
/api/posts/{id}/poll/progress | GET | Poll progress
/api/posts/{id}/poll/vote | POST | Vote poll
/api/posts/{id}/reopen | POST | Reopen post
/api/posts/{postId}/comments | GET | List comments
/api/posts/{postId}/comments | POST | Create comment
/api/posts/{postId}/donations | GET | List donations
/api/posts/{postId}/donations | POST | Donate
/api/posts/{postId}/reactions | POST | React to post
/api/posts/featured | GET | Featured posts
/api/posts/latest-reply | GET | Latest reply posts
/api/posts/ranking | GET | Ranking posts
/api/posts/recent | GET | Recent posts
/api/push/public-key | GET | Get public key
/api/push/subscribe | POST | Subscribe
/api/reaction-types | GET | List reaction types
/api/rss | GET | RSS feed
/api/search/global | GET | Global search
/api/search/posts | GET | Search posts
/api/search/posts/content | GET | Search posts by content
/api/search/posts/title | GET | Search posts by title
/api/search/users | GET | Search users
/api/sitemap.xml | GET | Sitemap
/api/stats/comments-range | GET | Comments range
/api/stats/dau | GET | Daily active users
/api/stats/dau-range | GET | DAU range
/api/stats/new-users-range | GET | New users range
/api/stats/posts-range | GET | Posts range
/api/subscriptions/comments/{commentId} | DELETE | Unsubscribe comment
/api/subscriptions/comments/{commentId} | POST | Subscribe comment
/api/subscriptions/posts/{postId} | DELETE | Unsubscribe post
/api/subscriptions/posts/{postId} | POST | Subscribe post
/api/subscriptions/users/{username} | DELETE | Unsubscribe user
/api/subscriptions/users/{username} | POST | Subscribe user
/api/tags | GET | List tags
/api/tags | POST | Create tag
/api/tags/{id} | DELETE | Delete tag
/api/tags/{id} | GET | Get tag
/api/tags/{id} | PUT | Update tag
/api/tags/{id}/posts | GET | List posts by tag
/api/upload | POST | Upload file
/api/upload/presign | GET | Presign upload
/api/upload/url | POST | Upload from URL
/api/users/{identifier} | GET | Get user
/api/users/{identifier}/all | GET | User aggregate
/api/users/{identifier}/followers | GET | Followers
/api/users/{identifier}/following | GET | Following users
/api/users/{identifier}/hot-posts | GET | User hot posts
/api/users/{identifier}/hot-replies | GET | User hot replies
/api/users/{identifier}/hot-tags | GET | User hot tags
/api/users/{identifier}/posts | GET | User posts
/api/users/{identifier}/replies | GET | User replies
/api/users/{identifier}/subscribed-posts | GET | Subscribed posts
/api/users/{identifier}/tags | GET | User tags
/api/users/admins | GET | Admin users
/api/users/me | GET | Current user
/api/users/me | PUT | Update profile
/api/users/me/avatar | POST | Upload avatar
/api/users/me/signin | POST | Daily sign in

List activities GET

Next Page

###
On this page

接口列表