api

package

Go to main page

Versions in this module

v0

v0.2.7

May 22, 2026

v0.2.6

May 21, 2026

Changes in this version

+ func ServerVersion(req component.BetterRequest[component.Null]) component.Response

v0.2.5

May 21, 2026

Changes in this version

+ func ArticleSource(req component.BetterRequest[ArticleSourceReq]) component.Response

+ type ArticleSourceReq struct

+ Id uint64

+ type ArticleSourceVo struct

+ ArticleStatus int8

+ CategoryId []uint64

+ Content string

+ CreatedAt string

+ Description string

+ Id uint64

+ ProcessStatus int8

+ Title string

+ Type int8

+ UpdatedAt string

+ UserId uint64

v0.2.4

May 20, 2026

v0.2.3

May 20, 2026

v0.2.2

May 20, 2026

Changes in this version

+ func BadgeList(req component.BetterRequest[component.Null]) component.Response

+ func DeleteBadge(req component.BetterRequest[BadgeDeleteReq]) component.Response

+ func EditArticleCategories(req component.BetterRequest[EditArticleCategoriesReq]) component.Response

+ func GetUnreadStatus(req component.BetterRequest[GetUnreadCountReq]) component.Response

+ func SaveBadge(req component.BetterRequest[BadgeSaveReq]) component.Response

+ func SaveUserBadges(req component.BetterRequest[SaveUserBadgesReq]) component.Response

+ func UserBadgeOptions(req component.BetterRequest[UserBadgeOptionsReq]) component.Response

type ArticlesInfoAdminVo

+ CategoryId []uint64

+ type BadgeDeleteReq struct

+ Code string

+ type BadgeSaveReq struct

+ Code string

+ Color string

+ Description string

+ GrantMode string

+ IconKey string

+ IconType string

+ IconURL string

+ IsEnabled bool

+ Level string

+ Name string

+ SortOrder int

+ Type string

+ type EditArticleCategoriesReq struct

+ CategoryId []uint64

+ Id uint64

+ type SaveUserBadgesReq struct

+ BadgeCodes []string

+ UserId uint64

+ type UserBadgeOptionsReq struct

+ UserId uint64

+ type UserBadgeOptionsResp struct

+ Active []badgeservice.UserBadge

+ Options []badgeservice.Badge

type UserItem

+ Badges []badgeservice.UserBadge

v0.2.1

May 19, 2026

Changes in this version

+ func GetUserHoverCard(req component.BetterRequest[GetUserCardReq]) component.Response

v0.1.2

May 12, 2026

v0.1.1

Apr 17, 2026

Changes in this version

+ func DeleteChat(req component.BetterRequest[DeleteChatReq]) component.Response

+ func GetChatList(req component.BetterRequest[GetChatListReq]) component.Response

+ func GetMessages(req component.BetterRequest[GetMessagesReq]) component.Response

+ func GetPostingSettings(req component.BetterRequest[null]) component.Response

+ func GetSecuritySettings(req component.BetterRequest[null]) component.Response

+ func GetTrafficOverview(req component.BetterRequest[TrafficOverviewReq]) component.Response

+ func GetUserActivities(req component.BetterRequest[GetUserActivitiesReq]) component.Response

+ func GetUserCard(req component.BetterRequest[GetUserCardReq]) component.Response

+ func MarkChatRead(req component.BetterRequest[MarkReadReq]) component.Response

+ func SavePostingSettings(req component.BetterRequest[SavePostingSettingsReq]) component.Response

+ func SaveSecuritySettings(req component.BetterRequest[SaveSecuritySettingsReq]) component.Response

+ func SendMessage(req component.BetterRequest[SendMessageReq]) component.Response

+ type ArticlesInfoAdminVo struct

+ ArticleStatus int8

+ CreatedAt string

+ Description string

+ Id uint64

+ LikeCount uint64

+ ProcessStatus int8

+ ReplyCount uint64

+ Title string

+ Type int8

+ UpdatedAt string

+ UserAvatarUrl string

+ UserId uint64

+ Username string

+ ViewCount uint64

+ type ArticlesInfoVo struct

+ ArticleStatus int8

+ CreatedAt string

+ Id uint64

+ ProcessStatus int8

+ Title string

+ Type int8

+ UpdatedAt string

+ UserId uint64

+ Username string

type CategoryItem

+ Color string

+ Icon string

+ Slug string

type CategorySaveReq

+ Color string

+ Icon string

+ Slug string

+ type DailyTraffic struct

+ ArticleCount int64

+ Date string

+ RegCount int64

+ ReplyCount int64

+ type DeleteChatReq struct

+ ConvId uint64

+ type GetChatListReq struct

+ type GetMessagesReq struct

+ ConvId uint64

+ Page int

+ PageSize int

+ type GetUserActivitiesReq struct

+ LastId uint64

+ Limit int

+ UserId uint64

+ type GetUserCardReq struct

+ UserId uint64

+ type MarkReadReq struct

+ ConvId uint64

+ type SavePostingSettingsReq struct

+ Settings pageConfig.PostingContent

+ type SaveSecuritySettingsReq struct

+ Settings pageConfig.SecurityAndRegistration

+ type SendMessageReq struct

+ Content string

+ MsgType int8

+ PeerId uint64

+ type TrafficOverviewReq struct

+ EndDate string

+ StartDate string

v0.0.10

Sep 23, 2025

v0.0.9

Aug 26, 2025

Changes in this version

+ func AdminDocsContentCreate(req component.BetterRequest[DocsContentCreateReq]) component.Response

+ func AdminDocsContentDelete(req component.BetterRequest[DocsContentDeleteReq]) component.Response

+ func AdminDocsContentDetail(req component.BetterRequest[component.Null]) component.Response

+ func AdminDocsContentDraft(req component.BetterRequest[DocsContentDraftReq]) component.Response

+ func AdminDocsContentList(req component.BetterRequest[DocsContentListReq]) component.Response

+ func AdminDocsContentPreview(req component.BetterRequest[DocsContentPreviewReq]) component.Response

+ func AdminDocsContentPublish(req component.BetterRequest[DocsContentPublishReq]) component.Response

+ func AdminDocsContentUpdate(req component.BetterRequest[DocsContentUpdateReq]) component.Response

+ func AdminDocsProjectCreate(req component.BetterRequest[DocsProjectCreateReq]) component.Response

+ func AdminDocsProjectDelete(req component.BetterRequest[DocsProjectDeleteReq]) component.Response

+ func AdminDocsProjectDetail(req component.BetterRequest[component.Null]) component.Response

+ func AdminDocsProjectList(req component.BetterRequest[DocsProjectListReq]) component.Response

+ func AdminDocsProjectUpdate(req component.BetterRequest[DocsProjectUpdateReq]) component.Response

+ func AdminDocsVersionCreate(req component.BetterRequest[DocsVersionCreateReq]) component.Response

+ func AdminDocsVersionDelete(req component.BetterRequest[DocsVersionDeleteReq]) component.Response

+ func AdminDocsVersionDetail(req component.BetterRequest[component.Null]) component.Response

+ func AdminDocsVersionDirectoryUpdate(req component.BetterRequest[DocsVersionDirectoryUpdateReq]) component.Response

+ func AdminDocsVersionList(req component.BetterRequest[DocsVersionListReq]) component.Response

+ func AdminDocsVersionSetDefault(req component.BetterRequest[component.Null]) component.Response

+ func AdminDocsVersionUpdate(req component.BetterRequest[DocsVersionUpdateReq]) component.Response

+ func ApplyAddLink(req component.BetterRequest[ApplyAddLinkReq]) component.Response

+ func ApplySheet(req component.BetterRequest[ApplySheetListReq]) component.Response

+ func ArticlesList(req component.BetterRequest[ArticlesListReq]) component.Response

+ func ChangePassword(req component.BetterRequest[ChangePasswordReq]) component.Response

+ func DeleteCategory(req ...) component.Response

+ func DeleteNotification(req component.BetterRequest[DeleteNotificationReq]) component.Response

+ func EditArticle(req component.BetterRequest[EditArticleReq]) component.Response

+ func EditUser(req component.BetterRequest[EditUserReq]) component.Response

+ func EditUserEmail(req component.BetterRequest[EditUserEmailReq]) component.Response

+ func EditUserInfo(req component.BetterRequest[EditUserInfoReq]) component.Response

+ func EditUsername(req component.BetterRequest[EditUsernameReq]) component.Response

+ func ForgotPassword(req component.BetterRequest[ForgotPasswordReq]) component.Response

+ func GetAllRoleItem(req component.BetterRequest[GetAllRoleItemReq]) component.Response

+ func GetAnnouncement(req component.BetterRequest[null]) component.Response

+ func GetCaptcha() component.Response

+ func GetCategoryList(req component.BetterRequest[CategoryListReq]) component.Response

+ func GetFileByFileName(c *gin.Context)

+ func GetFooterLinks(req component.BetterRequest[null]) component.Response

+ func GetFriendLinks(req component.BetterRequest[null]) component.Response

+ func GetLastUnread(req component.BetterRequest[GetUnreadCountReq]) component.Response

+ func GetMailSettings(req component.BetterRequest[null]) component.Response

+ func GetNotificationList(req component.BetterRequest[GetNotificationListReq]) component.Response

+ func GetNotificationTypes(req component.BetterRequest[GetNotificationTypesReq]) component.Response

+ func GetPermissionList(req component.BetterRequest[PermissionListReq]) component.Response

+ func GetSiteSettings(req component.BetterRequest[null]) component.Response

+ func GetSponsors(req component.BetterRequest[null]) component.Response

+ func GetUnreadCount(req component.BetterRequest[GetUnreadCountReq]) component.Response

+ func GetWebSettings(req component.BetterRequest[null]) component.Response

+ func Invitation(req component.BetterRequest[null]) component.Response

+ func MarkAllAsRead(req component.BetterRequest[MarkAllAsReadReq]) component.Response

+ func MarkAsRead(req component.BetterRequest[MarkAsReadReq]) component.Response

+ func OptRecordPage(req component.BetterRequest[OptRecordPageReq]) component.Response

+ func QueryNotificationList(req component.BetterRequest[QueryNotificationListReq]) component.Response

+ func ResetPassword(req component.BetterRequest[ResetPasswordReq]) component.Response

+ func RoleDel(req component.BetterRequest[RoleSaveDel]) component.Response

+ func RoleList(req component.BetterRequest[RoleListReq]) component.Response

+ func RoleSave(req component.BetterRequest[RoleSaveReq]) component.Response

+ func SaveAnnouncement(req component.BetterRequest[SaveAnnouncementReq]) component.Response

+ func SaveCategory(req component.BetterRequest[CategorySaveReq]) component.Response

+ func SaveFooterLinks(req component.BetterRequest[SaveFooterLinksReq]) component.Response

+ func SaveFriendLinks(req component.BetterRequest[SaveFriendLinksReq]) component.Response

+ func SaveImgByGinContext(c *gin.Context)

+ func SaveMailSettings(req component.BetterRequest[SaveMailSettingsReq]) component.Response

+ func SaveSiteSettings(req component.BetterRequest[SaveSiteSettingsReq]) component.Response

+ func SaveSponsors(req component.BetterRequest[SaveSponsorsReq]) component.Response

+ func SaveUser(userEntity *users.EntityComplete) error

+ func SaveWebSettings(req component.BetterRequest[SaveWebSettingsReq]) component.Response

+ func TestMailConnection(req component.BetterRequest[TestMailConnectionReq]) component.Response

+ func UploadAvatar(c *gin.Context)

+ func UserInfo(req component.BetterRequest[null]) component.Response

+ func UserList(req component.BetterRequest[UserListReq]) component.Response

+ type ApplyAddLinkReq struct

+ Contact string

+ Email string

+ SiteDesc string

+ SiteLogo string

+ SiteName string

+ SiteUrl string

+ type ApplySheetListReq struct

+ Page int

+ PageSize int

+ Search string

+ UserId uint64

+ type ArticlesInfoAdminDto struct

+ ArticleStatus int8

+ CreatedAt string

+ Description string

+ Id uint64

+ LikeCount uint64

+ ProcessStatus int8

+ ReplyCount uint64

+ Title string

+ Type int8

+ UpdatedAt string

+ UserAvatarUrl string

+ UserId uint64

+ Username string

+ ViewCount uint64

+ type ArticlesInfoDto struct

+ ArticleStatus int8

+ CreatedAt string

+ Id uint64

+ ProcessStatus int8

+ Title string

+ Type int8

+ UpdatedAt string

+ UserId uint64

+ Username string

+ type ArticlesListReq struct

+ Page int

+ PageSize int

+ Search string

+ UserId uint64

+ type CategoryItem struct

+ Category string

+ Desc string

+ Id uint64

+ Sort int

+ Status int8

+ type CategoryListReq struct

+ Page int

+ PageSize int

+ type CategorySaveReq struct

+ Category string

+ Desc string

+ Id uint64

+ Sort int

+ Status int8

+ type ChangePasswordReq struct

+ NewPassword string

+ OldPassword string

+ type DeleteNotificationReq struct

+ NotificationId uint64

+ type DocsContentCreateReq struct

+ Content string

+ Slug string

+ SortOrder int

+ Title string

+ VersionId uint64

+ type DocsContentDeleteReq struct

+ Id uint64

+ type DocsContentDraftReq struct

+ Id uint64

+ type DocsContentItem struct

+ Content string

+ CreatedAt string

+ Id uint64

+ IsPublished int8

+ LikeCount uint64

+ ProjectId uint64

+ ProjectName string

+ Slug string

+ SortOrder int

+ Title string

+ UpdatedAt string

+ VersionId uint64

+ VersionName string

+ ViewCount uint64

+ type DocsContentListReq struct

+ Keyword string

+ Page int

+ PageSize int

+ Status *int8

+ VersionId *uint64

+ type DocsContentPreviewReq struct

+ Content string

+ type DocsContentPreviewResponse struct

+ Html string

+ Toc string

+ type DocsContentPublishReq struct

+ Id uint64

+ type DocsContentUpdateReq struct

+ Content string

+ Id uint64

+ Slug string

+ SortOrder int

+ Title string

+ VersionId uint64

+ type DocsProjectCreateReq struct

+ Description string

+ IsPublic int8

+ LogoUrl string

+ Name string

+ OwnerId uint64

+ Slug string

+ Status int8

+ type DocsProjectDeleteReq struct

+ Id uint64

+ type DocsProjectItem struct

+ CreatedAt string

+ Description string

+ Id uint64

+ IsPublic int8

+ LogoUrl string

+ Name string

+ OwnerId uint64

+ OwnerName string

+ Slug string

+ Status int8

+ UpdatedAt string

+ type DocsProjectListReq struct

+ IsPublic *int8

+ Keyword string

+ Page int

+ PageSize int

+ Status *int8

+ type DocsProjectUpdateReq struct

+ Description string

+ Id uint64

+ IsPublic int8

+ LogoUrl string

+ Name string

+ OwnerId uint64

+ Slug string

+ Status int8

+ type DocsVersionCreateReq struct

+ Description string

+ IsDefault int8

+ Name string

+ ProjectId uint64

+ Slug string

+ SortOrder int

+ Status int8

+ type DocsVersionDeleteReq struct

+ type DocsVersionDirectoryUpdateReq struct

+ DirectoryStructure []docVersions.DirectoryItem

+ type DocsVersionItem struct

+ CreatedAt string

+ Description string

+ DirectoryStructure []docVersions.DirectoryItem

+ Id uint64

+ IsDefault int8

+ Name string

+ ProjectId uint64

+ ProjectName string

+ Slug string

+ SortOrder int

+ Status int8

+ UpdatedAt string

+ type DocsVersionListReq struct

+ Keyword string

+ Page int

+ PageSize int

+ ProjectId *uint64

+ Status int8

+ type DocsVersionSetDefaultReq struct

+ Id uint64

+ type DocsVersionUpdateReq struct

+ Description string

+ Id uint64

+ IsDefault int8

+ Name string

+ ProjectId uint64

+ Slug string

+ SortOrder int

+ Status int8

+ type EditArticleReq struct

+ Id uint64

+ ProcessStatus int8

+ type EditUserEmailReq struct

+ Email string

+ type EditUserInfoReq struct

+ Bio string

+ ExternalInformation users.ExternalInformation

+ Nickname string

+ Signature string

+ Website string

+ WebsiteName string

+ type EditUserReq struct

+ RoleId uint64

+ Status int8

+ UserId uint64

+ Validate int8

+ type EditUsernameReq struct

+ Username string

+ type ForgotPasswordReq struct

+ CaptchaCode string

+ CaptchaId string

+ Email string

+ type GetAllRoleItemReq struct

+ type GetNotificationListReq struct

+ Page int

+ PageSize int

+ UnreadOnly bool

+ type GetNotificationTypesReq struct

+ type GetUnreadCountReq struct

+ type MarkAllAsReadReq struct

+ type MarkAsReadReq struct

+ NotificationId uint64

+ type OptRecordPageReq struct

+ type PermissionItem struct

+ Id uint64

+ Name string

+ type PermissionListReq struct

+ type QueryNotificationListReq struct

+ PageSize int

+ StartId int

+ UnreadOnly bool

+ type ResetPasswordReq struct

+ NewPassword string

+ Token string

+ type RoleItem struct

+ CreateTime string

+ Effective int

+ Permissions []PermissionItem

+ RoleId uint64

+ RoleName string

+ type RoleListReq struct

+ type RoleSaveDel struct

+ Id uint

+ type RoleSaveReq struct

+ Id uint

+ Permissions []uint64

+ RoleName string

+ type SaveAnnouncementReq struct

+ Settings pageConfig.AnnouncementConfig

+ type SaveFooterLinksReq struct

+ FooterConfig pageConfig.FooterConfig

+ type SaveFriendLinksReq struct

+ LinksInfo []pageConfig.FriendLinksGroup

+ type SaveMailSettingsReq struct

+ Settings pageConfig.MailSettingsConfig

+ type SaveSiteSettingsReq struct

+ Settings pageConfig.SiteSettingsConfig

+ type SaveSponsorsReq struct

+ SponsorsInfo pageConfig.SponsorsConfig

+ type SaveWebSettingsReq struct

+ Settings pageConfig.WebSettingsConfig

+ type TestMailConnectionReq struct

+ Settings pageConfig.MailSettingsConfig

+ TestEmail string

+ type TestMailConnectionResp struct

+ Message string

+ Success bool

+ type UserItem struct

+ AvatarUrl string

+ CreateTime string

+ Email string

+ LastActiveTime string

+ Prestige int64

+ RoleId uint64

+ RoleList []datastruct.Option[string, uint64]

+ Status int8

+ UserId uint64

+ Username string

+ Validate int8

+ type UserListReq struct

+ Email string

+ Page int

+ PageSize int

+ UserId uint64

+ Username string

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL