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。

相关文章

JVM 的类初始化机制

JVM 的类初始化机制

前言 当你在 Java 程序中new对象时，有没有考虑过 JVM 是如何把静态的字节码（byte code）转化为运行时对象的呢，这个问题看似简单，但清楚的同学相信也不会太多，这篇文章首先介绍 JVM 类初始化的机制，然后给出几个易出错的实例来分析，帮助大家更好理解这个知识点。 JVM 将字节码转化为运行时对象分为三个阶段，分别是：loading 、Linking、initialization
阅读更多...
Spring Security 基于表达式的权限控制

Spring Security 基于表达式的权限控制

前言 spring security 3.0已经可以使用spring el表达式来控制授权，允许在表达式中使用复杂的布尔逻辑来控制访问的权限。 常见的表达式 Spring Security可用表达式对象的基类是SecurityExpressionRoot。 表达式描述hasRole([role])用户拥有制定的角色时返回true （Spring security默认会带有ROLE_前缀）,去
阅读更多...
浅析Spring Security认证过程

浅析Spring Security认证过程

类图 为了方便理解Spring Security认证流程，特意画了如下的类图，包含相关的核心认证类 概述 核心验证器 AuthenticationManager 该对象提供了认证方法的入口，接收一个Authentiaton对象作为参数; public interface AuthenticationManager {Authentication authenticate(Authenti
阅读更多...
Spring Security--Architecture Overview

Spring Security--Architecture Overview

1 核心组件 这一节主要介绍一些在Spring Security中常见且核心的Java类，它们之间的依赖，构建起了整个框架。想要理解整个架构，最起码得对这些类眼熟。 1.1 SecurityContextHolder SecurityContextHolder用于存储安全上下文（security context）的信息。当前操作的用户是谁，该用户是否已经被认证，他拥有哪些角色权限…这些都被保
阅读更多...
Spring Security基于数据库验证流程详解

Spring Security基于数据库验证流程详解

Spring Security 校验流程图 相关解释说明（认真看哦） AbstractAuthenticationProcessingFilter 抽象类 /*** 调用 #requiresAuthentication(HttpServletRequest, HttpServletResponse) 决定是否需要进行验证操作。* 如果需要验证，则会调用 #attemptAuthentica
阅读更多...
Spring Security 从入门到进阶系列教程

Spring Security 从入门到进阶系列教程

Spring Security 入门系列 《保护 Web 应用的安全》 《Spring-Security-入门（一）：登录与退出》 《Spring-Security-入门（二）：基于数据库验证》 《Spring-Security-入门（三）：密码加密》 《Spring-Security-入门（四）：自定义-Filter》 《Spring-Security-入门（五）：在 Sprin
阅读更多...
Java架构师知识体认识

Java架构师知识体认识

源码分析 常用设计模式 Proxy代理模式Factory工厂模式Singleton单例模式Delegate委派模式Strategy策略模式Prototype原型模式Template模板模式 Spring5 beans 接口实例化代理Bean操作 Context Ioc容器设计原理及高级特性Aop设计原理Factorybean与Beanfactory Transaction 声明式事物
阅读更多...
Java进阶13讲__第12讲_1/2

Java进阶13讲__第12讲_1/2

多线程、线程池 1.  线程概念 1.1  什么是线程 1.2  线程的好处 2.   创建线程的三种方式 注意事项 2.1  继承Thread类 2.1.1 认识  2.1.2  编码实现  package cn.hdc.oop10.Thread;import org.slf4j.Logger;import org.slf4j.LoggerFactory
阅读更多...
hdu1043（八数码问题，广搜 + hash（实现状态压缩） ）

hdu1043（八数码问题，广搜 + hash（实现状态压缩） ）

利用康拓展开将一个排列映射成一个自然数，然后就变成了普通的广搜题。 #include<iostream>#include<algorithm>#include<string>#include<stack>#include<queue>#include<map>#include<stdio.h>#include<stdlib.h>#include<ctype.h>#inclu
阅读更多...
JAVA智听未来一站式有声阅读平台听书系统小程序源码

JAVA智听未来一站式有声阅读平台听书系统小程序源码

智听未来，一站式有声阅读平台听书系统 🌟&nbsp;开篇：遇见未来，从“智听”开始 在这个快节奏的时代，你是否渴望在忙碌的间隙，找到一片属于自己的宁静角落？是否梦想着能随时随地，沉浸在知识的海洋，或是故事的奇幻世界里？今天，就让我带你一起探索“智听未来”——这一站式有声阅读平台听书系统，它正悄悄改变着我们的阅读方式，让未来触手可及！ 📚&nbsp;第一站：海量资源，应有尽有 走进“智听
阅读更多...

Copyright China编程 23002807@qq.com

沪ICP备2023033072号-2