javalin实现restful接口并集成swagger设置header字段

2024-04-20 07:08
文章标签 java 实现 接口 设置 swagger 集成 字段 restful header lin

本文主要是介绍javalin实现restful接口并集成swagger设置header字段，希望对大家解决编程问题提供一定的参考价值，需要的开发者们随着小编来一起学习吧！

javalin实现restful接口并集成swagger设置header字段

 

配置依赖

dependencies {implementation fileTree(dir: "lib", include: ['*.jar'])implementation 'cn.hutool:hutool-all:5.3.5'implementation 'io.javalin:javalin-bundle:4.1.1'implementation 'com.alibaba:druid:1.2.6'implementation 'org.mybatis:mybatis:3.5.4'runtimeOnly 'com.oracle:ojdbc6:11.2.0.3'compileOnly 'org.projectlombok:lombok:1.18.12'annotationProcessor 'org.projectlombok:lombok:1.18.12'//implementation 'io.springfox:springfox-swagger-ui:3.0.0'//implementation 'io.springfox:springfox-swagger2:3.0.0'}

代码中增加OpenApiPlugin ,增加swagger的支持

package com.soft;import java.util.concurrent.TimeUnit;import org.eclipse.jetty.http.HttpStatus;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;import com.soft.config.HeaderParam;
import com.soft.config.Router;
import com.soft.config.ServerConf;
import com.soft.controller.TestController;
import com.soft.controller.UserController;
import com.soft.event.EventListener;
import com.soft.exception.AppException;
import com.soft.exception.BaseException;
import com.soft.util.CacheUtil;
import com.soft.util.ErrorType;
import com.soft.util.RetResult;import cn.hutool.core.util.RandomUtil;
import cn.hutool.core.util.StrUtil;
import io.javalin.Javalin;
import io.javalin.apibuilder.ApiBuilder;
import io.javalin.http.util.NaiveRateLimit;
import io.javalin.plugin.openapi.InitialConfigurationCreator;
import io.javalin.plugin.openapi.OpenApiOptions;
import io.javalin.plugin.openapi.OpenApiPlugin;
import io.javalin.plugin.openapi.ui.ReDocOptions;
import io.javalin.plugin.openapi.ui.SwaggerOptions;
import io.swagger.v3.oas.models.Components;
import io.swagger.v3.oas.models.OpenAPI;
import io.swagger.v3.oas.models.info.Info;
import io.swagger.v3.oas.models.security.SecurityScheme;public class AppStart {private static final Logger log = LoggerFactory.getLogger(AppStart.class);public static void main(String[] args) {Javalin app = Javalin.create(config -> {config.registerPlugin(getConfiguredOpenApiPlugin());config.defaultContentType = "application/json";}).start(ServerConf.getVo().getPort());CacheUtil.eventBus.register(new EventListener());beforeHandle(app);afterHandle(app);exceptionHandle(app);app.routes(() -> {ApiBuilder.get(Router.ping, TestController::ping);ApiBuilder.post(Router.verifyPwd, UserController::verifyPwd);});}private static OpenApiPlugin getConfiguredOpenApiPlugin() {// swagger-ui中输入框传入请求头参数验证// controller中每个接口方法中必须增加@OpenApiSecurity注解才能生效InitialConfigurationCreator init = () -> {Components comps = new Components();comps.addSecuritySchemes(HeaderParam.X_APP_ID, buildSecurityScheme(HeaderParam.X_APP_ID)).addSecuritySchemes(HeaderParam.X_APP_KEY, buildSecurityScheme(HeaderParam.X_APP_KEY));return new OpenAPI().info(new Info().version("1.0").description("接口")).components(comps);};OpenApiOptions options = new OpenApiOptions(init).activateAnnotationScanningFor("com.soft.controller").path("/swagger-docs") // endpoint for OpenAPI json.swagger(new SwaggerOptions("/swagger")) // endpoint for swagger-ui.reDoc(new ReDocOptions("/redoc")) // endpoint for redoc.defaultDocumentation(doc -> {
//					doc.json("500", ErrorResponse.class);
//					doc.json("503", ErrorResponse.class);});return new OpenApiPlugin(options);}private static SecurityScheme buildSecurityScheme(String name) {return new SecurityScheme().type(SecurityScheme.Type.APIKEY).in(SecurityScheme.In.HEADER).name(name);}private static void beforeHandle(Javalin app) {app.before("/*", ctx -> {// throws if rate limit is exceededNaiveRateLimit.requestPerTimeUnit(ctx, ServerConf.getVo().getX_RateLimit_Limit(), TimeUnit.SECONDS);String logid = RandomUtil.randomString(5);ctx.attribute("logid", logid);String ip = ctx.ip();String path = ctx.path();if (path.contains("/test/ping") || path.contains("/swagger")) {return;}String body = ctx.body();String reqid = ctx.header(HeaderParam.X_CTG_Request_ID);log.info("reqid:{}|{}|REQ ip:{},path:{},body:{}", reqid, logid, ip, path, body);String x_app_id = ctx.req.getHeader(HeaderParam.X_APP_ID);String x_app_key = ctx.req.getHeader(HeaderParam.X_APP_KEY);if (StrUtil.isBlank(x_app_id) || StrUtil.isBlank(x_app_key)) {String msg = "请求头中 X-APP-ID, X-APP-KEY 必须传送";throw new AppException(ErrorType.BadReq, msg);}if (!StrUtil.equalsIgnoreCase(x_app_id, ServerConf.getVo().getX_APP_ID())) {String msg = "请求头中X-APP-ID与服务端配置不同";throw new AppException(ErrorType.BadReq, msg);}if (!StrUtil.equalsIgnoreCase(x_app_key, ServerConf.getVo().getX_APP_KEY())) {String msg = "请求头中X-APP-KEY与服务端配置不同";throw new AppException(ErrorType.BadReq, msg);}});}private static void afterHandle(Javalin app) {app.after("/*", ctx -> {// 2.1.7请求跟踪, 设置与请求头相同的值String reqid = ctx.req.getHeader(HeaderParam.X_CTG_Request_ID);ctx.res.addHeader("X-CTG-Request-ID", reqid);String logid = ctx.attribute("logid");log.info("reqid:{}|{}|RSP status:{} body:{}", reqid, logid, ctx.status(), ctx.resultString());});}private static void exceptionHandle(Javalin app) {
//		app.exception(NullPointerException.class, (e, ctx) -> {
//			// handle nullpointers here
//			log.error("", e);
//			ctx.status(HttpStatus.INTERNAL_SERVER_ERROR_500).result("NullPointerException");
//		});app.exception(Exception.class, (ex, ctx) -> {RetResult re = null;if (ex instanceof BaseException) {// 自定义异常BaseException e = (BaseException) ex;re = new RetResult(e.getCode(), e.getMessage());} else {re = new RetResult(ErrorType.Fail.getCode(), ex.getMessage());log.error("", ex);}ctx.status(HttpStatus.INTERNAL_SERVER_ERROR_500).json(re);});}
}


package com.soft.controller;import java.util.ArrayList;
import java.util.Date;
import java.util.List;import org.eclipse.jetty.http.HttpStatus;import io.javalin.http.Context;
import io.javalin.plugin.openapi.annotations.HttpMethod;
import io.javalin.plugin.openapi.annotations.OpenApi;
import io.javalin.plugin.openapi.annotations.OpenApiContent;
import io.javalin.plugin.openapi.annotations.OpenApiRequestBody;
import io.javalin.plugin.openapi.annotations.OpenApiResponse;
import io.javalin.plugin.openapi.annotations.OpenApiSecurity;public class UserController {@OpenApi(path = Router.verifyPwd, method = HttpMethod.POST, summary = "3.21 密码验证", requestBody = @OpenApiRequestBody(content = @OpenApiContent(from = VerifyPwdReq.class)), security = {@OpenApiSecurity(name = HeaderParam.X_APP_ID), @OpenApiSecurity(name = HeaderParam.X_APP_KEY) })/*** 3.21 密码验证** @param req* @return*/public static void verifyPwd(Context ctx) {VerifyPwdReq req = ctx.bodyValidator(VerifyPwdReq.class).check(o -> StrUtil.isNotBlank(o.getLoginname()), Param.ACCOUNT_NO_NULL).check(o -> StrUtil.isNotBlank(o.getPasswd()), Param.PASSWD_NO_NULL).get();//省略代码ctx.status(HttpStatus.BAD_REQUEST_400).json(re);}}

1.访问swagger页面

 

2.输入X-APP-ID, X-APP-KEY的值,并点击Authorize按钮

3.进行各接口方法测试

点击各接口测试发送按钮,则会自动在header中带上X-APP-ID, X-APP-KEY的值

这篇关于javalin实现restful接口并集成swagger设置header字段的文章就介绍到这儿，希望我们推荐的文章对编程师们有所帮助！


http://www.chinasem.cn/article/919599。

相关文章

golang版本升级如何实现

golang版本升级如何实现

《golang版本升级如何实现》：本文主要介绍golang版本升级如何实现问题,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教... 目录golanwww.chinasem.cng版本升级linux上golang版本升级删除golang旧版本安装golang最新版本总结gola
阅读更多...
java如何解压zip压缩包

java如何解压zip压缩包

《java如何解压zip压缩包》：本文主要介绍java如何解压zip压缩包问题,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教... 目录Java解压zip压缩包实例代码结果如下总结java解压zip压缩包坐在旁边的小伙伴问我怎么用 java 将服务器上的压缩文件解压出来，
阅读更多...
SpringBoot中SM2公钥加密、私钥解密的实现示例详解

SpringBoot中SM2公钥加密、私钥解密的实现示例详解

《SpringBoot中SM2公钥加密、私钥解密的实现示例详解》本文介绍了如何在SpringBoot项目中实现SM2公钥加密和私钥解密的功能,通过使用Hutool库和BouncyCastle依赖,简化... 目录一、前言1、加密信息(示例)2、加密结果(示例)二、实现代码1、yml文件配置2、创建SM2工具
阅读更多...
Spring WebFlux 与 WebClient 使用指南及最佳实践

Spring WebFlux 与 WebClient 使用指南及最佳实践

《SpringWebFlux与WebClient使用指南及最佳实践》WebClient是SpringWebFlux模块提供的非阻塞、响应式HTTP客户端,基于ProjectReactor实现,... 目录Spring WebFlux 与 WebClient 使用指南1. WebClient 概述2. 核心依
阅读更多...
Mysql实现范围分区表(新增、删除、重组、查看)

Mysql实现范围分区表(新增、删除、重组、查看)

《Mysql实现范围分区表(新增、删除、重组、查看)》MySQL分区表的四种类型（范围、哈希、列表、键值）,主要介绍了范围分区的创建、查询、添加、删除及重组织操作,具有一定的参考价值,感兴趣的可以了解... 目录一、mysql分区表分类二、范围分区（Range Partitioning1、新建分区表：2、分
阅读更多...
MySQL 定时新增分区的实现示例

MySQL 定时新增分区的实现示例

《MySQL定时新增分区的实现示例》本文主要介绍了通过存储过程和定时任务实现MySQL分区的自动创建,解决大数据量下手动维护的繁琐问题,具有一定的参考价值,感兴趣的可以了解一下... mysql创建好分区之后，有时候会需要自动创建分区。比如，一些表数据量非常大，有些数据是热点数据，按照日期分区MululbU
阅读更多...
Spring Boot @RestControllerAdvice全局异常处理最佳实践

Spring Boot @RestControllerAdvice全局异常处理最佳实践

《SpringBoot@RestControllerAdvice全局异常处理最佳实践》本文详解SpringBoot中通过@RestControllerAdvice实现全局异常处理,强调代码复用、统... 目录前言一、为什么要使用全局异常处理？二、核心注解解析1. @RestControllerAdvice2
阅读更多...
Spring IoC 容器的使用详解(最新整理)

Spring IoC 容器的使用详解(最新整理)

《SpringIoC容器的使用详解(最新整理)》文章介绍了Spring框架中的应用分层思想与IoC容器原理,通过分层解耦业务逻辑、数据访问等模块,IoC容器利用@Component注解管理Bean... 目录1. 应用分层2. IoC 的介绍3. IoC 容器的使用3.1. bean 的存储3.2. 方法注
阅读更多...
Python设置Cookie永不超时的详细指南

Python设置Cookie永不超时的详细指南

《Python设置Cookie永不超时的详细指南》Cookie是一种存储在用户浏览器中的小型数据片段,用于记录用户的登录状态、偏好设置等信息,下面小编就来和大家详细讲讲Python如何设置Cookie... 目录一、Cookie的作用与重要性二、Cookie过期的原因三、实现Cookie永不超时的方法（一）
阅读更多...
MySQL中查找重复值的实现

MySQL中查找重复值的实现

《MySQL中查找重复值的实现》查找重复值是一项常见需求,比如在数据清理、数据分析、数据质量检查等场景下,我们常常需要找出表中某列或多列的重复值,具有一定的参考价值,感兴趣的可以了解一下... 目录技术背景实现步骤方法一：使用GROUP BY和HAVING子句方法二：仅返回重复值方法三：返回完整记录方法四：
阅读更多...

Copyright China编程 23002807@qq.com

沪ICP备2023033072号-2