关于swagger-ui简单使用
swagger-ui为了将我们的更好展示,类似接口文档,方便前端同事做开发
pom依赖
1 2 3 4 5 6 7 8 9 10 | <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId> <version> 2.6 . 1 </version> </dependency> <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger-ui</artifactId> <version> 2.6 . 1 </version> </dependency> |
配置
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 | import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; import springfox.documentation.builders.PathSelectors; import springfox.documentation.builders.RequestHandlerSelectors; import springfox.documentation.spi.DocumentationType; import springfox.documentation.spring.web.plugins.Docket; import springfox.documentation.swagger2.annotations.EnableSwagger2; /** * @Description: * @Author: 喵星人 * @Create: 2023/9/25 9:56 */ @Configuration @EnableSwagger2 @ConditionalOnProperty (name = "swagger.enabled" , havingValue = "true" ) public class Swagger2Config { @Bean public Docket createRestApi() { return new Docket(DocumentationType.SWAGGER_2) .select() .apis(RequestHandlerSelectors.basePackage( "com.java" )) .paths(PathSelectors.any()) .build() ; } } |
1 2 3 4 5 6 7 | @PostMapping ( "/get_user_list" ) @ResponseBody @ApiOperation (value = "查询所有用户" , notes = "查询所有用户" , response = UserVo. class ,responseContainer = "List" ) public ResDTO getUserList( @RequestBody UserParm queryParam) throws Exception { List<UserVo> orgInfo = userService.get(queryParam); return ResDTO.ok(orgInfo); } |
访问地址是 127.0.0.1:8080/swagger-ui.html,需要注意的是有的项目会加上根路径,同时项目中还使用权限管理,这时需要查询浏览器的后台日志打印,显示401的需要忽略
不同环境做管控
1 | @ConditionalOnProperty (name = "swagger.enabled" , havingValue = "true" ) |
1 2 | swagger开关, true 为打开, false 为关闭 swagger.enabled: true |
可以根据实际情况配置
【推荐】国内首个AI IDE,深度理解中文开发场景,立即下载体验Trae
【推荐】编程新体验,更懂你的AI,立即体验豆包MarsCode编程助手
【推荐】抖音旗下AI助手豆包,你的智能百科全书,全免费不限次数
【推荐】轻量又高性能的 SSH 工具 IShell:AI 加持,快人一步
· TypeScript + Deepseek 打造卜卦网站:技术与玄学的结合
· Manus的开源复刻OpenManus初探
· AI 智能体引爆开源社区「GitHub 热点速览」
· C#/.NET/.NET Core技术前沿周刊 | 第 29 期(2025年3.1-3.9)
· 从HTTP原因短语缺失研究HTTP/2和HTTP/3的设计差异
2021-09-25 使用idea构建简单的熔断器hystrix