一、简介wno_interface 是一款微型的接口配置管理工具旨在应对实际项目中日益增长的接口调试、开发与后期维护工作这些工作负担随着项目的不断迭代而逐渐加重。接口的开发、调试、上线及下线共同构成了一个接口的完整生命周期。若在项目中集成接口则需频繁地修改代码并进行升级这无疑带来了较大的风险。本工具正是为解决这一棘手问题而设计的。它实现了接口的开发调测、上线、下线灵活性使得接口的控制能够随时进行变更并即时生效从而有效节省了接口调试与升级所需的时间。1.1 技术栈框架技术版本核心框架Spring Boot2.5.6持久层框架jdbctemplate5.3.12数据库连接池Alibaba Druid1.1.10模板解析Groovy3.0.9json解析fastjson22.0.12Xquery解析Saxon-HE11.3sshjsch0.1.551.2 部署手册1.2.1 数据初始化目前平台支持MySql\Oracle\PostgreSQL\teldb版本只需要修改数据源配置亦可。具体脚本见 resources/sql目录下脚本。 数据库导入完成后需要修改数据源地址wno704.quartzDB属性信息为了防止对数据库污染表前缀可以根据自己情况变动需要配置wno704.tablePrefix同时修改导入脚本中表前缀目前默认为INTF_日志目录需要配置wno704.logDir。1.2.2 编译构件传统的springboot项目目前生成物为jar包如需要war请参考 《Spring-Boot项目创建》1.2.3 服务部署发布到服务器后执行java -jar jar包名称,快捷部署可以参考 《Linux下部署Spring-Boot-jar》二、接口配置2.1 DS基础配置说明字段说明SOURCE_ID数据源idTYPE类型目前支持MySQL Oracle PostgreSQL类型JDBCTEMPLATE_NAMEjdbc名称DRIVER_CLASS_NAMEjdbc驱动classURL数据库链接字符串USERNAME数据库帐号PASSWORD数据库密码DB_DESC数据源描述STATUS可用状态 0使用 1下线CONFIG其他配置多个配置换行属性名称和值用:隔开CREATE_TIME创建时间READ_TIME读取时间注意如果修改了数据库等配置需要修改CREATE_TIME为当前时间定时器读取了后会自动更新READ_TIME字段。2.2 接口配置参数字段说明INTF_ID接口idMETHOD方法目前支持所有类型请求例如POST\GET\PUT\DELETE\PATCH等URL路径如果为匹配路径情况变动位置用%替代SCRIPT脚本REMARK备注STATUS可用状态 0使用 1下线IS_LOG是否保存日志 0保存 1不保存CREATE_TIME创建时间READ_TIME读取时间注意如果修改了数据库等配置需要修改CREATE_TIME为当前时间定时器读取了后会自动更新READ_TIME字段。2.3 脚本配置说明参考脚本import javax.servlet.http.HttpServletRequest import javax.servlet.http.HttpServletResponse import com.alibaba.fastjson2.JSONObject MapString, String reqHeaders (MapString, String)$reqHeaders String reqParam (String)$reqParam String method (String)$method String url (String)$url String msgId (String)$msgId String ipAddr (String)$ipAddr HttpServletRequest httpServletRequest (HttpServletRequest)$httpServletRequest HttpServletResponse httpServletResponse (HttpServletResponse)$httpServletResponse MapString, String queryParams (MapString, String)$queryParams String qp JSONObject.toJSONString(queryParams) String repMsg {msg: 请求成功,code: 200,msgId: msgId,reqParam:reqParam,queryParams:qp,ipAddr:ipAddr} MapString, Object repHeaders new HashMap() repHeaders.put(Content-Type,application/json; charsetutf-8) MapString, Object res new HashMap() res.put(repHeaders,repHeaders) res.put(repMsg,repMsg) res.put(repStatus,200) return res复制目前脚本默认传了9个参数返回需要携带3个参数。具体参数说明如下类型参数类型标签说明输入reqHeadersMapString, String$reqHeaders接口请求头的所有信息输入reqParamString$reqParam接口请求报文输入methodString$method接口请求方法输入urlString$url接口请求路径输入msgIdString$msgId系统自动生成的消息id如果保存调用记录这个就是记录表主键输入ipAddrString$ipAddr接口请求原始IP输入httpServletRequestHttpServletRequest$httpServletRequest请求对象输入httpServletResponseHttpServletResponse$httpServletResponse响应对象输入queryParamsMapString, String$queryParams接口请求查询参数输出repHeadersMapString, StringrepHeaders接口响应头信息输出repMsgStringrepMsg接口响应报文输出repStatusIntegerrepStatus接口响应状态注意 引入工具类参考 https://wno704.cn/wno_util/2.4 接口记录说明字段说明对应脚本字段LOG_ID主键$msgIdINTF_ID接口id无METHOD方法$methodURL路径$uriREMARK备注无REQUEST_IPADDR请求IP$ipAddrREQUEST_HEADERS请求头信息$reqHeadersREQUEST_PARAM请求参数$queryParamsREQUEST_MSG请求报文$reqParamREQUEST_TIME请求时间无RESPONSE_HEADERS响应头信息repHeadersRESPONSE_STATUS响应状态repStatusRESPONSE_MSG响应头报文repMsgRESPONSE_TIME响应时间无