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。

相关文章

windos server2022里的DFS配置的实现

windos server2022里的DFS配置的实现

《windosserver2022里的DFS配置的实现》DFS是WindowsServer操作系统提供的一种功能,用于在多台服务器上集中管理共享文件夹和文件的分布式存储解决方案,本文就来介绍一下wi... 目录什么是DFS？优势：应用场景：DFS配置步骤什么是DFS？DFS指的是分布式文件系统（Distr
阅读更多...
NFS实现多服务器文件的共享的方法步骤

NFS实现多服务器文件的共享的方法步骤

《NFS实现多服务器文件的共享的方法步骤》NFS允许网络中的计算机之间共享资源,客户端可以透明地读写远端NFS服务器上的文件,本文就来介绍一下NFS实现多服务器文件的共享的方法步骤,感兴趣的可以了解一... 目录一、简介二、部署1、准备1、服务端和客户端：安装nfs-utils2、服务端：创建共享目录3、服
阅读更多...
SpringBoot使用Apache Tika检测敏感信息

SpringBoot使用Apache Tika检测敏感信息

《SpringBoot使用ApacheTika检测敏感信息》ApacheTika是一个功能强大的内容分析工具,它能够从多种文件格式中提取文本、元数据以及其他结构化信息,下面我们来看看如何使用Ap... 目录Tika 主要特性1. 多格式支持2. 自动文件类型检测3. 文本和元数据提取4. 支持 OCR（光学
阅读更多...
Java内存泄漏问题的排查、优化与最佳实践

Java内存泄漏问题的排查、优化与最佳实践

《Java内存泄漏问题的排查、优化与最佳实践》在Java开发中,内存泄漏是一个常见且令人头疼的问题,内存泄漏指的是程序在运行过程中,已经不再使用的对象没有被及时释放,从而导致内存占用不断增加,最终... 目录引言1. 什么是内存泄漏？常见的内存泄漏情况2. 如何排查 Java 中的内存泄漏？2.1 使用 J
阅读更多...
JAVA系统中Spring Boot应用程序的配置文件application.yml使用详解

JAVA系统中Spring Boot应用程序的配置文件application.yml使用详解

《JAVA系统中SpringBoot应用程序的配置文件application.yml使用详解》：本文主要介绍JAVA系统中SpringBoot应用程序的配置文件application.yml的... 目录文件路径文件内容解释1. Server 配置2. Spring 配置3. Logging 配置4. Ma
阅读更多...
Java 字符数组转字符串的常用方法

Java 字符数组转字符串的常用方法

《Java字符数组转字符串的常用方法》文章总结了在Java中将字符数组转换为字符串的几种常用方法,包括使用String构造函数、String.valueOf()方法、StringBuilder以及A... 目录1. 使用String构造函数1.1 基本转换方法1.2 注意事项2. 使用String.valu
阅读更多...
C#使用yield关键字实现提升迭代性能与效率

C#使用yield关键字实现提升迭代性能与效率

《C#使用yield关键字实现提升迭代性能与效率》yield关键字在C#中简化了数据迭代的方式,实现了按需生成数据,自动维护迭代状态,本文主要来聊聊如何使用yield关键字实现提升迭代性能与效率,感兴... 目录前言传统迭代和yield迭代方式对比yield延迟加载按需获取数据yield break显式示迭
阅读更多...
Python实现高效地读写大型文件

Python实现高效地读写大型文件

《Python实现高效地读写大型文件》Python如何读写的是大型文件,有没有什么方法来提高效率呢,这篇文章就来和大家聊聊如何在Python中高效地读写大型文件,需要的可以了解下... 目录一、逐行读取大型文件二、分块读取大型文件三、使用 mmap 模块进行内存映射文件操作（适用于大文件）四、使用 pand
阅读更多...
python实现pdf转word和excel的示例代码

python实现pdf转word和excel的示例代码

《python实现pdf转word和excel的示例代码》本文主要介绍了python实现pdf转word和excel的示例代码,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价... 目录一、引言二、python编程1，PDF转Word2，PDF转Excel三、前端页面效果展示总结一
阅读更多...
java脚本使用不同版本jdk的说明介绍

java脚本使用不同版本jdk的说明介绍

《java脚本使用不同版本jdk的说明介绍》本文介绍了在Java中执行JavaScript脚本的几种方式,包括使用ScriptEngine、Nashorn和GraalVM,ScriptEngine适用... 目录Java脚本使用不同版本jdk的说明1.使用ScriptEngine执行javascript2.
阅读更多...

Copyright China编程 23002807@qq.com

沪ICP备2023033072号-2