feat 完善注释

This commit is contained in:
Ironsp
2026-10-01 17:24:57 +08:00
parent 2b59f68fd7
commit 9f4a5c7cda
183 changed files with 485 additions and 3615 deletions

View File

@@ -1,11 +1,4 @@
// 首页接口(真实后端绑定)
// 后端: vermis-maker com.ruoyi.vermins.controller.pc.web.UserSideWebHomePageController
// 前缀: /web/home-page 鉴权: 公开接口,无需 token
// 门户入口: com.ruoyi.vermins.controller.pc.web.IPortalEntryUserController(首页快捷入口功能,并入本文件)
//
// 使用约定(与项目 SKILL.md 一致):
// 页面/组件禁止直接 import axios,一律经 store 调用本模块的 request<T>。
// 本文件只放「函数签名 + 请求路径」,不写业务逻辑。
import { request } from '@/utils/request'
import type {
AgreementFormVo,
@@ -17,7 +10,6 @@ import type {
ProjectSubmissionVo,
} from '@/types/business/home'
/** 项目状态统计 */
export function getProjectStatusCount(): Promise<ProjectStatusCount> {
return request<ProjectStatusCount>({
url: '/web/home-page/project-status-count',
@@ -25,7 +17,6 @@ export function getProjectStatusCount(): Promise<ProjectStatusCount> {
})
}
/** 业务服务类型列表 */
export function getServiceTypeList(): Promise<ProjectSubmissionVo[]> {
return request<ProjectSubmissionVo[]>({
url: '/web/home-page/service-type-list',
@@ -33,7 +24,6 @@ export function getServiceTypeList(): Promise<ProjectSubmissionVo[]> {
})
}
/** 业务类型详情(聚合 VO:projectSubmission / projectServiceType / projectSubmissionAttachment / projectSubmissionCatalog) */
export function getServiceTypeDetail(id: number | string): Promise<ProjectSubmissionInfo> {
return request<ProjectSubmissionInfo>({
url: `/web/home-page/service-type-detail/${id}`,
@@ -41,7 +31,6 @@ export function getServiceTypeDetail(id: number | string): Promise<ProjectSubmis
})
}
/** 轮播图列表 */
export function getCarouselList(): Promise<BannerVo[]> {
return request<BannerVo[]>({
url: '/web/home-page/carousel-list',
@@ -49,7 +38,6 @@ export function getCarouselList(): Promise<BannerVo[]> {
})
}
/** 平台介绍(富文本 HTML) */
export function getPlatformIntro(): Promise<AgreementFormVo> {
return request<AgreementFormVo>({
url: '/web/home-page/platform-intro',
@@ -57,7 +45,6 @@ export function getPlatformIntro(): Promise<AgreementFormVo> {
})
}
/** 联系信息(富文本 HTML) */
export function getContactInfo(): Promise<AgreementFormVo> {
return request<AgreementFormVo>({
url: '/web/home-page/contact-info',
@@ -65,14 +52,6 @@ export function getContactInfo(): Promise<AgreementFormVo> {
})
}
// 首页「案例库精选」接口(/web/projectCase/mostViewed)按资源归位到 `@/api/cases` 的 getFeaturedCases。
/**
* 查询用户门户入口列表
*
* <p>登录态返回该用户个性化后的分组结果;匿名返回固定目录。
* 两组数据由 groupType 区分(1 = 快捷、0 = 其他)。</p>
*/
export function getPortalEntryList(): Promise<PortalEntryVo[]> {
return request<PortalEntryVo[]>({
url: '/vermins/portalEntryUser/list',
@@ -80,14 +59,6 @@ export function getPortalEntryList(): Promise<PortalEntryVo[]> {
})
}
/**
* 快捷 / 其他入口互转
*
* <p>后端 add 的入参是 @RequestParam,必须走 query 而非 body。</p>
*
* @param id 入口 id
* @param type 目标分组:1 = 快捷、0 = 其他
*/
export function switchPortalEntryGroup(id: number, type: PortalEntryGroup): Promise<void> {
return request<void>({
url: '/vermins/portalEntryUser/add',