feat: 添加接口说明

This commit is contained in:
ageer
2025-05-03 15:27:46 +08:00
parent d22d2cb708
commit 009aa5f1a5
11 changed files with 50 additions and 23 deletions

View File

@@ -1,8 +1,6 @@
package org.ruoyi.controller;
import cn.dev33.satoken.annotation.SaIgnore;
import lombok.RequiredArgsConstructor;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

View File

@@ -231,9 +231,9 @@ springdoc:
version: '版本号: ${ruoyi.version}'
# 作者信息
contact:
name: Lion Li
email: crazylionli@163.com
url: https://gitee.com/dromara/RuoYi-Vue-Plus
name: ageerle
email: ageerle@163.com
url: https://gitee.com/ageerle/ruoyi-ai
components:
# 鉴权方式配置
security-schemes:
@@ -243,16 +243,8 @@ springdoc:
name: ${sa-token.token-name}
#这里定义了两个分组,可定义多个,也可以不定义
group-configs:
- group: 1.演示模块
packages-to-scan: org.dromara.demo
- group: 2.通用模块
packages-to-scan: org.dromara.web
- group: 3.系统模块
packages-to-scan: org.dromara.system
- group: 4.代码生成模块
packages-to-scan: org.dromara.generator
- group: 5.工作流模块
packages-to-scan: org.dromara.workflow
- group: 1.系统模块
packages-to-scan: org.ruoyi.system
# 防止XSS攻击
xss:

View File

@@ -30,7 +30,10 @@ import org.springframework.web.multipart.MultipartFile;
import java.util.List;
/**
* @author ageer
* 知识库管理
*
* @author ageerle
* @date 2025-05-03
*/
@Validated
@RequiredArgsConstructor

View File

@@ -16,6 +16,12 @@ import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
/**
* 绘画(换脸)任务查询
*
* @author ageerle
* @date 2025-05-03
*/
@Api(tags = "任务查询")
@RestController
@RequestMapping("/mj")

View File

@@ -14,10 +14,10 @@ import org.ruoyi.common.core.utils.OkHttpUtil;
import org.springframework.web.bind.annotation.*;
/**
* 描述:文生视频
* 文生视频
*
* @author ageerle@163.com
* date 2024/6/27
* @author ageerle
* @date 2025-05-03
*/
@RestController
@RequestMapping("/luma")

View File

@@ -15,9 +15,14 @@ import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
import java.util.Optional;
/**
* 绘画任务提交
*
* @author ageerle
* @date 2025-05-03
*/
@Api(tags = "任务提交")
@RestController
@RequestMapping("/mj/submit")

View File

@@ -14,6 +14,13 @@ import org.ruoyi.chat.service.chat.IChatCostService;
import org.ruoyi.common.core.utils.OkHttpUtil;
import org.springframework.web.bind.annotation.*;
/**
* 文生歌曲任务提交
*
* @author ageerle
* @date 2025-05-03
*/
@RestController
@RequestMapping("/sunoapi")
@RequiredArgsConstructor

View File

@@ -11,6 +11,13 @@ import org.ruoyi.chat.domain.dto.TaskConditionDTO;
import org.ruoyi.chat.util.MjOkHttpUtil;
import org.springframework.web.bind.annotation.*;
/**
* 绘画任务查询
*
* @author ageerle
* @date 2025-05-03
*/
@Api(tags = "任务查询")
@RestController
@RequestMapping("/mj/task")

View File

@@ -9,7 +9,10 @@ import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.*;
/**
* @author https://www.wdbyte.com
* 企业微信应用
*
* @author ageerle
* @date 2025-05-03
*/
@Slf4j
@RestController

View File

@@ -13,7 +13,10 @@ import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;
/**
* @author https://www.wdbyte.com
* 微信公众号登录
*
* @author ageerle
* @date 2025-05-03
*/
@Slf4j
@RestController

View File

@@ -13,7 +13,10 @@ import org.springframework.beans.factory.annotation.Value;
import org.springframework.web.bind.annotation.*;
/**
* @author <a href="https://github.com/binarywang">Binary Wang</a>
* 微信公众号登录校验
*
* @author ageerle
* @date 2025-05-03
*/
@RestController
@RequestMapping("/wx/cp")