diff --git a/sms-auth/sms-auth-common/pom.xml b/sms-auth/sms-auth-common/pom.xml index a82fa94..91e03dd 100644 --- a/sms-auth/sms-auth-common/pom.xml +++ b/sms-auth/sms-auth-common/pom.xml @@ -77,5 +77,11 @@ 1.37.0 + + io.springfox + springfox-boot-starter + 3.0.0 + + diff --git a/sms-auth/sms-auth-common/src/main/java/com/landaiqing/auth/common/config/SaTokenConfigure.java b/sms-auth/sms-auth-common/src/main/java/com/landaiqing/auth/common/config/SaTokenConfigure.java index ed49ce5..4b0db25 100644 --- a/sms-auth/sms-auth-common/src/main/java/com/landaiqing/auth/common/config/SaTokenConfigure.java +++ b/sms-auth/sms-auth-common/src/main/java/com/landaiqing/auth/common/config/SaTokenConfigure.java @@ -42,6 +42,9 @@ public class SaTokenConfigure implements WebMvcConfigurer { //拦截所有接口 .addPathPatterns("/**") //不拦截/user/doLogin登录接口 + .excludePathPatterns("/swagger-ui/**") + .excludePathPatterns("/swagger-ui.html") + .excludePathPatterns("/swagger-resources/**","/swagger-ui/**", "/v3/**", "/error") .excludePathPatterns("/student/login"); } } diff --git a/sms-auth/sms-auth-common/src/main/java/com/landaiqing/auth/common/config/SwaggerConfig.java b/sms-auth/sms-auth-common/src/main/java/com/landaiqing/auth/common/config/SwaggerConfig.java new file mode 100644 index 0000000..aa5f46c --- /dev/null +++ b/sms-auth/sms-auth-common/src/main/java/com/landaiqing/auth/common/config/SwaggerConfig.java @@ -0,0 +1,31 @@ +package com.landaiqing.auth.common.config; + +import org.springframework.context.annotation.Bean; +import org.springframework.context.annotation.Configuration; +import springfox.documentation.builders.RequestHandlerSelectors; +import springfox.documentation.oas.annotations.EnableOpenApi; +import springfox.documentation.service.ApiInfo; +import springfox.documentation.spi.DocumentationType; +import springfox.documentation.spring.web.plugins.Docket; + +/** + * @Classname SwaggerConfig + * @BelongsProject: student-Management-system + * @BelongsPackage: com.landaiqing.auth.common.config + * @Author: landaiqing + * @CreateTime: 2024-03-05 19:36 + * @Description: TODO + * @Version: 1.0 + */ +@Configuration +@EnableOpenApi +public class SwaggerConfig { + @Bean + public Docket docket(){ + return new Docket(DocumentationType.OAS_30) + .enable(true)//关闭Swagger + .select() + .apis(RequestHandlerSelectors.basePackage("com.landaiqing.controller")) + .build(); + } +} diff --git a/sms-auth/sms-auth-controller/src/main/java/com/landaiqing/controller/StudentController.java b/sms-auth/sms-auth-controller/src/main/java/com/landaiqing/controller/StudentController.java index 4333119..088f260 100644 --- a/sms-auth/sms-auth-controller/src/main/java/com/landaiqing/controller/StudentController.java +++ b/sms-auth/sms-auth-controller/src/main/java/com/landaiqing/controller/StudentController.java @@ -17,6 +17,8 @@ import com.landaiqing.domain.service.StudentDomainService; import com.landaiqing.domain.service.StudentPermissionDomainService; import com.landaiqing.dto.PermissionDTO; import com.landaiqing.dto.StudentDTO; +import io.swagger.annotations.Api; +import io.swagger.annotations.ApiOperation; import lombok.extern.slf4j.Slf4j; import org.apache.commons.lang3.StringUtils; import org.apache.ibatis.annotations.Param; @@ -39,6 +41,7 @@ import java.util.Map; @RestController @RequestMapping("/student/") @Slf4j +@Api(tags = "学生controller") public class StudentController { @Resource private StudentDomainService studentDomainService; @@ -54,6 +57,7 @@ public class StudentController { * @date: 2024/3/4 23:47 */ @PostMapping("upload") + @ApiOperation(value = "上传头像") public Result uploadAvatar(@RequestBody StudentDTO studentDTO) { try { if (log.isInfoEnabled()) { @@ -77,6 +81,7 @@ public class StudentController { * @date: 2024/3/5 12:03 */ @RequestMapping("queryAllStudent") + @ApiOperation(value = "分页查询学生") public Result> queryAllStudent(@RequestBody StudentDTO studentDTO) { try { if (log.isInfoEnabled()) { @@ -101,6 +106,7 @@ public class StudentController { * @date: 2024/3/5 12:03 */ @RequestMapping("queryPermission") + @ApiOperation(value = "权限查询") public Result> queryStudentPermission(@RequestBody StudentDTO studentDTO) { try { if (log.isInfoEnabled()) { @@ -122,6 +128,7 @@ public class StudentController { * zh_CN 中文 http://127.0.0.1:3001/zh_CN */ @GetMapping("/{language}") + @ApiOperation(value = "国际化测试") public String test(@PathVariable String language) { String text2 = MessageUtil.get("sutdent_center", language); @@ -136,6 +143,7 @@ public class StudentController { * @date: 2024/3/5 17:28 */ @RequestMapping("login") + @ApiOperation(value = "登录") public Result login(@RequestBody StudentDTO studentDTO) { try { if (log.isInfoEnabled()) { diff --git a/sms-auth/sms-auth-start/src/main/java/com/landaiqing/auth/AuthApplication.java b/sms-auth/sms-auth-start/src/main/java/com/landaiqing/auth/AuthApplication.java index 851e8f3..5a4011e 100644 --- a/sms-auth/sms-auth-start/src/main/java/com/landaiqing/auth/AuthApplication.java +++ b/sms-auth/sms-auth-start/src/main/java/com/landaiqing/auth/AuthApplication.java @@ -4,6 +4,7 @@ import org.mybatis.spring.annotation.MapperScan; import org.springframework.boot.SpringApplication; import org.springframework.boot.autoconfigure.SpringBootApplication; import org.springframework.context.annotation.ComponentScan; +import springfox.documentation.oas.annotations.EnableOpenApi; /** * 服务启动类 @@ -14,6 +15,7 @@ import org.springframework.context.annotation.ComponentScan; @SpringBootApplication @ComponentScan("com.landaiqing") @MapperScan("com.landaiqing.**.dao") +@EnableOpenApi public class AuthApplication { public static void main(String[] args) { SpringApplication.run(AuthApplication.class); diff --git a/sms-auth/sms-auth-start/src/main/resources/application.yml b/sms-auth/sms-auth-start/src/main/resources/application.yml index c56db0b..5f1a4fa 100644 --- a/sms-auth/sms-auth-start/src/main/resources/application.yml +++ b/sms-auth/sms-auth-start/src/main/resources/application.yml @@ -80,3 +80,4 @@ sa-token: +