注释完成

This commit is contained in:
ljq 2023-11-18 15:47:31 +08:00
parent a96fd136d0
commit d4bc968131
15 changed files with 214 additions and 55 deletions

View File

@ -7,6 +7,7 @@ import com.yzdx.AiInterviewer.entity.LogoEntity;
import com.yzdx.AiInterviewer.service.InterviewBackgroundService;
import com.yzdx.AiInterviewer.service.InterviewImagesService;
import com.yzdx.AiInterviewer.service.InterviewLogoService;
import io.swagger.annotations.ApiParam;
import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.*;
@ -25,9 +26,13 @@ public class InterviewController {
@Autowired
private InterviewBackgroundService backgroundService;
/**
* 获取公司logo
* @param encoding 公司编码
* @return R
*/
@GetMapping("/get_logoList")
public R getLogoList(String encoding){
public R getLogoList(@ApiParam("传入的值为:(String)encoding") String encoding){
if(encoding==null){
return R.error(401,"出错了!请重新登陆");
@ -39,8 +44,13 @@ public class InterviewController {
}
/**
* 添加公司Logo
* @param addInfo:图片名称,公司编码,添加人的id,添加图片的地址,添加的文件名
* @return R
*/
@PostMapping("/add_logo")
public R addLogo(@RequestBody Map<String,Object> addInfo) {
public R addLogo(@RequestBody @ApiParam("传入的值为addInfo:{(String)name,(String)encoding,(String)image,(Integer)userId,(String)filename}") Map<String,Object> addInfo) {
if(addInfo.size()==0){
return R.error("添加失败!");
@ -62,8 +72,13 @@ public class InterviewController {
}
/**
* 删除公司logo
* @param id 图片id
* @return R
*/
@GetMapping("/delete_logo")
public R deleteLogoById(Integer id){
public R deleteLogoById(@ApiParam("传入的值为:(Integer)id") Integer id){
Integer rows = LogoService.deleteLogoById(id);
if(rows!=1){
@ -73,8 +88,13 @@ public class InterviewController {
}
/**
* 获取公司背景图片2
* @param encoding 公司编码
* @return R
*/
@GetMapping("/get_backgroundList")
public R getBackgroundList(String encoding){
public R getBackgroundList(@ApiParam("传入的值:(String)encoding") String encoding){
if(encoding==null){
return R.error(401,"出错了!请重新登陆");
@ -86,9 +106,13 @@ public class InterviewController {
}
/**
* 添加背景图片
* @param addInfo :图片名称,公司编码,添加人的id,添加图片的地址,添加的文件名
* @return R
*/
@PostMapping("/add_background")
public R addBackground(@RequestBody Map<String,Object> addInfo) {
public R addBackground(@RequestBody @ApiParam("传入的值为:(String)name,(encoding)String,(String)image,(Integer)userId,(String)filename") Map<String,Object> addInfo) {
if(addInfo.size()==0){
return R.error("添加失败!");
@ -110,8 +134,13 @@ public class InterviewController {
}
/**
* 删除背景图片
* @param id 公司id
* @return R
*/
@GetMapping("/delete_background")
public R deleteBackgroundById(Integer id){
public R deleteBackgroundById(@ApiParam("传入的值为:(Integer)id") Integer id){
Integer rows = backgroundService.deleteBackgroundById(id);
if(rows!=1){
@ -121,8 +150,13 @@ public class InterviewController {
}
/**
* 获取面试官形象
* @param encoding 公司编码
* @return R
*/
@GetMapping("/get_imagesList")
public R getImagesList(String encoding){
public R getImagesList(@ApiParam("传入的值为:(String)encoding") String encoding){
if(encoding==null){
return R.error(401,"出错了!请重新登陆");
@ -134,8 +168,13 @@ public class InterviewController {
}
/**
* 添加面试官形象照片
* @param addInfo 图片名称,公司编码,添加人的id,添加图片的地址,添加的文件名
* @return R
*/
@PostMapping("/add_image")
public R addImage(@RequestBody Map<String,Object> addInfo) {
public R addImage(@RequestBody @ApiParam("传入的值addInfo:{(String)name,(encoding)String,(String)image,(Integer)userId,(String)filename}") Map<String,Object> addInfo) {
if(addInfo.size()==0){
return R.error("添加失败!");
@ -159,8 +198,13 @@ public class InterviewController {
}
/**
* 删除面试官形象
* @param id 图片id
* @return R
*/
@GetMapping("/delete_image")
public R deleteImageById(Integer id){
public R deleteImageById(@ApiParam("传入的值:(Integer)id") Integer id){
Integer rows = imagesService.deleteImageById(id);
if(rows!=1){

View File

@ -1,6 +1,7 @@
package com.yzdx.AiInterviewer.controller;
import com.yzdx.AiInterviewer.comment.R;
import com.yzdx.AiInterviewer.entity.Question;
import com.yzdx.AiInterviewer.entity.QuestionBank;
import com.yzdx.AiInterviewer.entity.SharedQuestionBank;
import com.yzdx.AiInterviewer.entity.dto.QuestionDto;
@ -42,8 +43,16 @@ public class QuestionController {
return R.success(typeList);
}
/**
* 搜索题库信息
* @param name 题库名
* @param type 题库类型
* @param encoding 公司编码
* @return R
*/
@GetMapping("/search_typeName")
public R searchTypeList(String name,String type,String encoding){
public R searchTypeList(@ApiParam("传入的值为:(String)name,(String)type,(String)encoding") String name,String type,String encoding){
if(name==null&&encoding==null){
return R.error("搜索失败,请稍后再试");
@ -52,8 +61,14 @@ public class QuestionController {
return R.success(questionBanks);
}
/**
* 获取题库列表
* @param encoding 公司编码
* @param type 题库类型
* @return R
*/
@GetMapping("/get_typeListByType")
public R getTypeListByType(String encoding,Integer type){
public R getTypeListByType(@ApiParam("传入的值为:(String)encoding,(Integer)type") String encoding,Integer type){
if(encoding==null||type==null){
return R.error("数据出错啦,请联系管理员!");
@ -64,11 +79,12 @@ public class QuestionController {
}
/**
* 添加题库信息
* @param addInfo typeName,encoding,userId
* @return R
* */
@PostMapping("/add_typeName")
public R addTypeName(@RequestBody @ApiParam("addInfo:typeName,encoding,userId") Map<String ,Object> addInfo){
public R addTypeName(@RequestBody @ApiParam("传入的值:{addInfo:(String)typeName,(String)encoding,(Integer)userId}") Map<String ,Object> addInfo){
if(addInfo.size()==0||addInfo.get("typeName")==null){
return R.error("添加失败,请检查输入");
@ -96,7 +112,7 @@ public class QuestionController {
/**
* 根据题库id删除题库
* @param typeId 传入的题库id
*
* return R
* */
@GetMapping("/delete_type")
public R deleteTypeName(@RequestParam @ApiParam("typeId:传入的题库id") Integer typeId){
@ -116,7 +132,7 @@ public class QuestionController {
/**
* 根据题库id更新题库
* @param updateType 更新题库的信息
*
* return R
* */
@PostMapping("/change_type")
public R changeTypeName(@RequestBody @ApiParam("updateType:修改的内容 typeId 修改的题库id typeName 修改的题库名称 userId 修改人的id") Map<String ,Object> updateType){
@ -157,10 +173,10 @@ public class QuestionController {
/**
* 根据公司编码查找题目
* @param encoding 公司编码
*
* return R
* */
@GetMapping("/get_questionList")
public R getQuestionList(@RequestParam String encoding){
public R getQuestionList( @ApiParam("传入的值:(String)encoding") String encoding){
if(encoding==null){
return R.error("出错了!请联系管理员");
}
@ -175,11 +191,11 @@ public class QuestionController {
}
/**
* 添加题目
* @param addQuestionInfo 添加题目信息
*
* @param addQuestionInfo 公司编码,题库类型id,题目详情,题目promote,题目标题,用户id
* return R
* */
@PostMapping("add_question")
public R addQuestion(@RequestBody Map<String,Object> addQuestionInfo){
public R addQuestion(@RequestBody @ApiParam("传入的值addQuestionInfo:{(String)encoding,(Integer)banId,(String)details,(String)promote,(Integer)userId),(String)title}") Map<String,Object> addQuestionInfo){
String title=(String)addQuestionInfo.get("title");
Integer bankId=(Integer) addQuestionInfo.get("bankId");
String details=(String)addQuestionInfo.get("details");
@ -200,11 +216,11 @@ public class QuestionController {
/**
* 修改题目
* @param addQuestionInfo 修改题目信息
*
* @param addQuestionInfo 公司编码,题库类型id,题目详情,题目promote,题目标题,用户id题目id
* return R
* */
@PostMapping("update_question")
public R updateQuestion(@RequestBody Map<String,Object> addQuestionInfo){
public R updateQuestion(@RequestBody @ApiParam("传入的值addQuestionInfo:{(Integer)id,(Integer)banId,(String)details,(String)promote,(String)encoding,(Integer)userId),(String)title}") Map<String,Object> addQuestionInfo){
Integer id=(Integer) addQuestionInfo.get("id");
String title=(String)addQuestionInfo.get("title");
Integer bankId=(Integer) addQuestionInfo.get("bankId");
@ -227,9 +243,10 @@ public class QuestionController {
/**
*删除题目
* @param id 删除题目的id
* return R
* */
@GetMapping("/del_question")
public R deleteQuestion(Integer id){
public R deleteQuestion(@ApiParam("传入的值:(Integer)id") Integer id){
Integer rows=questionService.deleteQuestion(id);
@ -268,6 +285,8 @@ public class QuestionController {
return R.error(result);
}
}

View File

@ -8,8 +8,14 @@ import com.yzdx.AiInterviewer.entity.dto.JobSettingDto;
import com.yzdx.AiInterviewer.service.CompanyService;
import com.yzdx.AiInterviewer.service.InterviewSettingService;
import com.yzdx.AiInterviewer.service.JobListService;
import com.yzdx.AiInterviewer.utiles.MyStringUtils;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.*;
import org.springframework.web.multipart.MultipartFile;
import javax.servlet.http.HttpSession;
import java.io.File;
import java.io.IOException;
import java.util.*;

View File

@ -21,7 +21,6 @@ import java.util.concurrent.Executors;
@Slf4j
public class UploadController {
//设置上传文件的最大大小
public static final int MAX_SIZE=10*1024*1024;
//设置文件的类型
@ -35,6 +34,12 @@ public class UploadController {
AVATAR_TYPE.add("image/jpeg");
}
/**
* 上传图片
* @param request
* @param file
* @return R
*/
@PostMapping("/upload_picture")
public R upLoadPicture(HttpServletRequest request, @RequestParam("file") MultipartFile file){
@ -93,6 +98,12 @@ public class UploadController {
return R.success(data);//返回图片存储在服务器的地址
}
/**
* 上传视频
* @param request
* @param file
* @return R
*/
@PostMapping("/upload_video")
public R upLoadVideo(HttpServletRequest request, @RequestParam("file") MultipartFile file ){
@ -145,6 +156,13 @@ public class UploadController {
data.put("filename",filename);
return R.success(data);//返回图片存储在服务器的地址
}
/**
* 删除照片
* @param request
* @param imagePath
* @return R
*/
@GetMapping("/delete_picture")
public R deletePicture(HttpServletRequest request,String imagePath){
if(imagePath==null||imagePath.equals("")){
@ -166,6 +184,13 @@ public class UploadController {
}
/**
* 删除视频
* @param request
* @param videoPath
* @return R
*/
@GetMapping("/delete_video")
public R deleteVideo(HttpServletRequest request,String videoPath){
if(videoPath==null||videoPath.equals("")){
@ -188,6 +213,12 @@ public class UploadController {
}
/**
* 上传简历
* @param request
* @param file
* @return R
*/
@PostMapping("/upload_resume")
public R uploadResume(HttpServletRequest request, @RequestParam("file") MultipartFile file){
if(file.isEmpty()){
@ -246,6 +277,12 @@ public class UploadController {
}
/**
* 删除简历
* @param request
* @param resumePath
* @return R
*/
@GetMapping("/delete_resume")
public R deleteResume(HttpServletRequest request,String resumePath){
if(resumePath==null||resumePath.equals("")){

View File

@ -19,9 +19,13 @@ public class UserController {
@Autowired
private UserService userService;
/**
* 用户登录
* @param loginForm 用户输入的账号密码公司编码
* @return R
* */
@PostMapping("/login")
public R adminLogin(@RequestBody @ApiParam("传入的值phone,encoding,password") Map<String,Object> loginForm){
public R adminLogin(@RequestBody @ApiParam("传入的值:loginForm:{(String)phone,(String)encoding,(String)password}") Map<String,Object> loginForm){
if(loginForm.size()==0){
return R.error("传来的数据有误,请检查输入");
@ -32,8 +36,13 @@ public class UserController {
return userService.adminLogin(phone, encoding, password);
}
/**
* 用户信息
* @param token 用户登录时返回的token
* @return R
*/
@GetMapping("/get_userInfo")
public R getUserInfo( @ApiParam("token值") String token) {
public R getUserInfo( @ApiParam("传入的值:(String)token值") String token) {
if(token==null){
return R.error(401,"非法访问,请重新登陆!");
@ -59,8 +68,13 @@ public class UserController {
return R.success(user);
}
/**
* 用户注销
* @param token 用户登录时返回的token
* @return R
*/
@GetMapping("/logout")
public R adminLogout(@ApiParam("token值") String token){
public R adminLogout(@ApiParam("传入的值:(String)token值") String token){
Integer row = userService.adminLogout(token);
@ -72,15 +86,27 @@ public class UserController {
}
/**
* 获取管理员列表
* @param encoding 公司编码
* @return R
*/
@GetMapping("/get_adminList")
public R getAdminList(@ApiParam("公司编码") String encoding){
public R getAdminList(@ApiParam("传入的值:(String)encoding") String encoding){
List<User> adminList = userService.getAdminList(encoding);
return R.success(adminList);
}
/**
* 搜索管理员
* @param name 管理员的姓名
* @param encoding 公司编码
* @return R
*/
@GetMapping("/search_admin")
public R searchAdmin(String name,String encoding){
public R searchAdmin(@ApiParam("传入的值:(String)name,(String)encoding") String name,String encoding){
if(name==null&&encoding==null){
return R.error("查询失败");
}
@ -88,8 +114,14 @@ public class UserController {
return R.success(users);
}
/**
* 添加管理员
* @param addAdminInfo 添加人的公司编码操作人的id,添加入的姓名添加入的手机号/账号添加人的权限
* @return R
*/
@PostMapping("/add_admin")
public R addAdmin(@RequestBody @ApiParam("传入的值 addAdminInfo:{encoding,userId,username,phone,role}") Map<String ,Object> addAdminInfo){
public R addAdmin(@RequestBody @ApiParam("传入的值 addAdminInfo:{(String)encoding,(Integer)userId,(String)username,(String)phone,(String)role}") Map<String ,Object> addAdminInfo){
String encoding=(String) addAdminInfo.get("encoding");
Integer userId=(Integer) addAdminInfo.get("userId");
String username=(String)addAdminInfo.get("username");
@ -109,8 +141,13 @@ public class UserController {
return R.success("添加管理员成功!");
}
/**
* 更新管理员信息
* @param deleteInfo 操作人的id删除人的id
* @return R
*/
@PostMapping("/del_admin")
public R deleteAdmin(@RequestBody Map<String,Object> deleteInfo){
public R deleteAdmin(@RequestBody @ApiParam("传入的值 deleteInfo:{(Integer)userId,(Integer)deleteId}") Map<String,Object> deleteInfo){
Integer deleteId=(Integer) deleteInfo.get("deleteId");
Integer userId=(Integer) deleteInfo.get("userId");
@ -131,8 +168,13 @@ public class UserController {
return R.success("删除成功!");
}
/**
* 更换头像
* @param updateInfo 更改人的id更改人头像的地址
* @return R
*/
@PostMapping("/change_avatar")
public R changeAvatar(@RequestBody Map<String,Object> updateInfo){
public R changeAvatar(@RequestBody @ApiParam("传入的值为updateInfo:(Integer)userId,(String)avatar") Map<String,Object> updateInfo){
Integer userId=(Integer) updateInfo.get("userId") ;
String avatar=(String)updateInfo.get("avatar") ;
@ -144,8 +186,14 @@ public class UserController {
}
/**
* 更新密码
* @param updateInfo 更新人的Id,新密码旧密码
* @return R
*/
@PostMapping("/reset_password")
public R resetPassword(@RequestBody Map<String,Object> updateInfo){
public R resetPassword(@RequestBody @ApiParam("传入的值为updateInfo:(Integer)userId,(String)oldPassword,(String)password") Map<String,Object> updateInfo){
Integer userId=(Integer)updateInfo.get("userId") ;
String oldPassword=(String)updateInfo.get("oldPassword");
@ -157,8 +205,13 @@ public class UserController {
return userService.resetPassword(userId,oldPassword,password);
}
/**
* 更新用户信息
* @param updateInfo 操作人的id更新人的id修改的名称修改的年龄修改的电子邮箱修改的性别
* @return R
*/
@PostMapping("/upload_userInfo")
public R updateUserInfo(@RequestBody Map<String,Object> updateInfo){
public R updateUserInfo(@RequestBody @ApiParam("传入的值为updateInfo:(Integer)userId,(Integer)updateId,(String)username,(String)age,(String)email,(String)sex") Map<String,Object> updateInfo){
Integer userId=(Integer) updateInfo.get("userId");
Integer updateId=(Integer) updateInfo.get("updateId");

View File

@ -3,10 +3,12 @@ package com.yzdx.AiInterviewer.entity;
import com.baomidou.mybatisplus.annotation.IdType;
import com.baomidou.mybatisplus.annotation.TableId;
import com.baomidou.mybatisplus.annotation.TableName;
import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import lombok.Data;
@Data
@ApiModel("面试背景实体类")
@TableName("interview_background")
public class BackgroundEntity extends BaseEntity{
@ApiModelProperty("背景图片id")

View File

@ -3,10 +3,12 @@ package com.yzdx.AiInterviewer.entity;
import com.baomidou.mybatisplus.annotation.IdType;
import com.baomidou.mybatisplus.annotation.TableId;
import com.baomidou.mybatisplus.annotation.TableName;
import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import lombok.Data;
@Data
@ApiModel("token黑名单实体类")
@TableName("black_token")
public class BlackToken {
@ApiModelProperty("token黑名单id")

View File

@ -3,9 +3,10 @@ package com.yzdx.AiInterviewer.entity;
import com.baomidou.mybatisplus.annotation.IdType;
import com.baomidou.mybatisplus.annotation.TableId;
import com.baomidou.mybatisplus.annotation.TableName;
import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import lombok.Data;
@ApiModel("面试官形象实体类")
@Data
@TableName("interview_images")
public class ImagesEntity extends BaseEntity{

View File

@ -3,10 +3,12 @@ package com.yzdx.AiInterviewer.entity;
import com.baomidou.mybatisplus.annotation.IdType;
import com.baomidou.mybatisplus.annotation.TableId;
import com.baomidou.mybatisplus.annotation.TableName;
import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import lombok.Data;
@Data
@ApiModel("工作实体类")
@TableName("Job_list")
public class JobEntity extends BaseEntity{

View File

@ -3,9 +3,10 @@ package com.yzdx.AiInterviewer.entity;
import com.baomidou.mybatisplus.annotation.IdType;
import com.baomidou.mybatisplus.annotation.TableId;
import com.baomidou.mybatisplus.annotation.TableName;
import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import lombok.Data;
@ApiModel("logo实体类")
@Data
@TableName("interview_logo")
public class LogoEntity extends BaseEntity{

View File

@ -14,8 +14,8 @@ public interface CompanyService extends IService<Company> {
Company getCompanyDetail(String encoding);
/**
* 更新公司详情
* @param userId 跟新人的id
* @param encoding 跟心公司的编码
* @param userId 人的id
* @param encoding 公司的编码
* @param address 公司地址
* @param companyDetail 公司详情
* @param addressDetail 公司详情地址

View File

@ -28,7 +28,7 @@ public interface InterviewImagesService extends IService<ImagesEntity> {
Integer addImageLogo(String name,String encoding,String image,String video,Integer userId,String filename);
/**
* 添加logo
* 删除logo
* @param id 图片id
* @return 映像的行数
*

View File

@ -27,7 +27,7 @@ public interface InterviewLogoService extends IService<LogoEntity> {
Integer addAddLogo(String name,String encoding,String image,Integer userId,String filename);
/**
* 添加logo
* 删除logo
* @param id 图片id
* @return 映像的行数
*

View File

@ -48,10 +48,14 @@ public interface QuestionService extends IService<Question> {
* */
Integer updateQuestion(Integer id,String title,Integer bankId,String details,String promote,String encoding,Integer userId);
/**
* 删除题目
* @param id 删除题目的id
* @return 改变的行数
* */
Integer deleteQuestion(Integer id);
}

View File

@ -3,17 +3,5 @@ package com.yzdx.AiInterviewer.service;
import com.baomidou.mybatisplus.extension.service.IService;
import com.yzdx.AiInterviewer.entity.SharedQuestion;
import java.util.List;
public interface SharedQuestionService extends IService<SharedQuestion> {
/**
* 增加题目
* @param sharedBankId 分享题库id
* @param selectQuestionId 分享题目的id
* @param userId 分享人
* @return 影响的行数
*
* */
String addShardQuestions(Integer sharedBankId, List<Integer> selectQuestionId,Integer userId);
}