当前位置： 首页 > news >正文

一个WEB端的API测试工具、API文档编写工具、定时任务调度工具

news 2025/10/21 10:55:52

试用地址

http://182.92.210.97/scmp/static/index.html#/request/api

图示

在这里插入图片描述
在这里插入图片描述
在这里插入图片描述
在这里插入图片描述

下载资源

从Github或者Gitee下载,从source目录获取资源,包含 scmp.jar lib/other/*.jar sqlit-db.db static

启动脚本

jdk8

java -jar scmp.jar \--db.type=sqlit \--spring.datasource.url=jdbc:sqlite:./sqlit-db.db \ # 配置为你的salit-db.db 路径--project.location-file-path=file:./static/ \ # 配置为你的static目录路径--project.socket.ports=3501 \ # webSocket 端口配置--spring.profiles.active=pro >/dev/null 2>&1 & # 如果要控制台启动，可以不使用这一行，同时注意去掉上一行结果的反斜杠/

java -jar .\scmp.jar --db.type=sqlit --spring.datasource.url=jdbc:sqlite:./sqlit-db.db --project.location-file-path=file:./static/

此项目也可以支持服务器部署，如有需要同我联系

邮箱：17610759800@163.com qq:1270622569 微信: zfs1270622569

访问

http://127.0.0.1:3500/scmp/static/index.html#/request/api

使用文档

NBA-API-使用帮助

特色

API

  • GET POST PUT DELETE 常用方法接口测试
  • 支持 RESTFul接口语法
  • SSE(Server-Sent Events)测试
  • WebSocket测试
  • localhost接口测试(非本地部署,需要安装插件)
  • 特殊能力
    • 将Fetch请求代码转成成API接口文档
    • 可以对单个接口同时发起N次请求
    • 可以按照API打开的顺序依次发起请求
    • 可以同时对打开的API发起请求
    • 可以通过自定义JavaScript脚本对参数值进行修改
    • Body-json支持注释(json5语法)
    • 可以对单个API进行分享
    • 可以选中多个API组合分享或者生成api使用文档
    • Swagger注解标注的java文件转换成API文档
    • 支持本地(橘黄色文件夹为本地API文件标记)存储(不能分享,不能参与API文档管理,不能参与API选择)

API使用文档

  • 将多个API组合成一个文档,在文档内进行详细记录
  • 可以将API使用文档进行分享
  • 文档支持多人协同编辑

Swagger文档解析(暂未具体测试和优化)

定时任务调度

  • 支持CRON表达式
  • 支持RRULE表达式

Setting-Config

该功能是位于侧边栏的齿轮形状的图标

用户名称配置

  • 用于api文档组,多人进行文档协同时,用户名信息的展示

全局请求头配置

  • 又可叫做[本地请求头管理].
  • 配置数据只缓存在本地浏览器,不会存储到服务器上
  • 有效期为24小时 (2025.8.8) 一直有效
  • 注:API的局部请求头[Header]配置会覆盖全局的请求头配置。即局部的请求头优先级最高

全局执行次数配置

  • 配置对某一个API同时发起N次请求的执行次数
  • 只对本地生效,
  • 缓存有效期:理论上为永久有效

远程请求环境配置

  • 用于配置环境对应的域名信息,例如name=生产,domain=www.pro.qq.com
  • 远程请求环境配置数据会同步存储到服务器,再所有成员间共享

本地请求环境配置

  • 用于配置环境对应的域名信息,例如name=生产,domain=www.pro.qq.com
  • 配置信息缓存在本地,只再本地使用,只对自己生效
  • 缓存有效期:理论上为永久有效
  • 注:本地请求环境不等于本地测试

API管理

主要用于API测试
可以通过API的存储方式控制API的存储位置,远程:API记录在服务器上,本地:API记录在本地缓存内(IndexDB)
本地API:不参与API选择,不能分享,不参与API文档管理.橘黄色文件夹代表本地API

API结构

建议如下

项目
模块
Controller || REST
方法（具体的api）

新建/编辑

  1. API管理左上角的[加号(➕)]图标,
  2. 选中目录或者API后右键菜单下的[编辑目录]
  3. [新建子目录]
  4. [新建子API]
值默认值说明
类型目录/API目录标记当前新建的是目录还是API
存储远程/本地远程API或者文件夹数据存储位置,本地存储的数据会再根节点使用橘黄色图标标记
父级API目录树无父级所在目录,用于控制层级关系
名称名称无API或者目录的名称
描述描述无对当前内容的简要描述
ContextPathcontext-path无对应项目的server.servlet.context-path配置
注:新建子级时会将父级的配置信息传递给子级。
注:修改父级的配置信息时，不会修改已存在的子级配置信息
PrefixPrefix无一般填写项目内Controller上统一的请求前缀
注:新建子级时会将父级的配置信息传递给子级。
注:修改父级的配置信息时，不会修改已存在的子级配置信息
Methodget/post/put/delete无API请求方法(当类型为API时必填)
PathPath无一般填写Controller下method上的请求路径(当类型为API时必填)
SSESSE关闭是否采用SSE(Server-Sent Events)方法执行请求
WebSocketWebSocket关闭是否是websocket请求

API树

  • 支持通过[拖拽的方式]调整API的树结构关系

API树右键菜单

功能如其名

  • 刷新目录
  • 编辑目录
  • 删除目录(API)
    • 如果目录下存在子元素(目录或者API)则不允许删除
  • 新建子目录
  • 新建子API

API树下拉菜单

  • 分享已打开的API
    • 选择需要的API文档在右侧打开，然后通过该功能生成分享链接，进而分享打开的API
  • 选择API
    • 使用此菜单后，API树会展示复选框□，勾选想要分享的API后，

      便可使用编辑API使用文档菜单或者分享已选择的API菜单
    • 注:本地存储的API不支出选择,不支持分享,不支持参与API使用文档
  • 编辑API使用文档
    • 通过选择API菜单选择需要的API，然后通过该菜单弹出API文档编辑弹框,进而为选中的这批API的编写详细使用文档
  • 分享已选择的API
    • 通过选择API菜单选择需要的API，然后通过该菜单便可生成分享链接
  • 关闭API选择
    • 此菜单只有在使用选择API菜单后,才会展示,作用是隐藏API选择的复选框

API测试

选择一个创建后的API,单击即可再右侧打开,进而进行测试

  • API 列表标签
    • 已打开的API
    • 如果API有变更,会有星号(*)提示,
    • 使用标签上的关闭API功能(×)时,会验证API是否有变更,如果有变更会提示保存
    • 右键菜单也有部分功能,详细使用文档查看[API 列表标签右键菜单]
    • 支持拖拽标签页修改API的打开顺序
  • API 路径
    • 请求方法: GET POST PUT DELETE
    • 请求环境: 包含本地请求环境配置信息,以及远程请求环境配置信息
    • Context-Path: 对应Context-Path
    • Prefix: 对应Prefix
    • Path: 对应Path
    • 支持 REST full api,详细使用文档查看[RESTful API 的使用]
    • 执行和下拉菜单,详细使用文档查看[执行和下拉菜单]
  • API 配置
    • 配置API的详细信息,包含基础信息(Api Detail),请求头(Header),请求参数(Query),请求体(Body)
    • 详细使用文档查看[API 配置]
  • API 执行结果
    • 展示API测试结果,
      • 单次请求的响应结果(ResponseData),响应头(ResponseHeader)
      • 多次请求的结果需要[全局执行次数配置]
        请求后,通过响应区的[结果N]进行查看
    • 详细使用文档查看[API 执行结果]

API 列表标签右键菜单

  • 关闭文档
  • 关闭其他文档
  • 关闭全部文档
  • 关闭左侧文档
  • 关闭右侧文档
  • 顺序执行打开的API
    • 按照API打开的顺序,依次执行一次,可以通过选择对应的API标签页查看执行结果
  • 并行执行打开的API
    • 同时对打开的API发起请求,仅请求一次,可以通过选择对应的API标签页查看执行结果

RESTful API 的使用

本项目支持RESTful(Representational State Transfer)格式的API

  • 注:路径内容用到的相关参数需要再Query内进行配置
  • 例如:Path=/user/{id},则Query内需要配置id对应的参数信息

执行和下拉菜单

  • 执行(执行一次)
    • 对API进行单次的调用,可以通过选择对应的API标签页查看执行结果
    • 快捷键 windows:Ctrl+Enter Mac:⌘+Enter
  • 下拉菜单
    • 执行N次: 对API同时发起N次请求.可以通过[Setting-Config>全局执行次数配置]进行配置
    • 保存API:
    • 更新API: 修改API后,建议更新保存,可以通过 Ctrl+s/command+s快捷键触发更新
      • 如果有其他端同时打开了该API,则其他端的标签页后边会出现同步图标,点击同步图标后,则可将更新内容同步到本地
    • 预览API: 是一个API文档的概要描述
    • 分享API: 该菜单会生成一个API分享路径.
      • 注:本地存储的API不支持分享
    • 复制路径: url路径

API 配置

  • Api Detail
    • 是否是SSE(Server-Sent Events)请求
    • 存储:远程,本地(橘黄色图标标记为本地存储)
    • name: 名称
    • desc: 描述
    • FetchCode: 功能辅助输入框.用Fetch请求代码转换成API文档
      • 打开控制台,选择NetWork,找到对应的请求,右键=>Copy=>Copay as fetch,然后粘贴到此处,点击[FetchToRequest]按钮解析
    • FetchToRequest: 按钮,将FetchCode转换成API文档
  • Headers
    • 功能: 局部请求头配置
    • 字段: 参数名(请求头名称) 参数值 描述
    • 注:此处的局部请求头信息如果存在和全局请求头相同的参数名,则以局部请求头为准
  • Query
    • 功能: 请求参数配置
    • 字段: 参数名 参数类型 参数值 描述
    • 预览 添加 删除 图标
    • 拖拽: 鼠标移动到列首,鼠标会变成上下拖拽的图标,可以对对应的列进行拖追排序
  • Message
    • 功能: 进行WebSocket测试
    • 可自定义输入消息内容,可通过设置 json/text/xml 设置编辑器语言
    • 通过Binary控制发送消息时使用进行二进制编码
    • 发送按钮:发送消息
  • Body
    • 功能: 请求体参数配置
    • content-type: application/json multipart/form-data application/x-www-form-urlencoded
      • application/json[json]: json格式的数据,支持JSON5语法,可以通过字段描述功能添加字段文档
      • multipart/form-data[form-data]: 表单方式提交,可以上传文件
      • application/x-www-form-urlencoded[urlencoded]: …
    • content-type=json
      • 参数编辑框支持JSON5数据格式
      • 有右键菜单,具体功能不详细描述
      • 可以通过快捷键(option+shift+f)格式化文档,具体快捷键可通过右键菜单查看
  • Script
    • 功能: 参数格处理的js脚本
    • 提供一个函数名为buildParam的函数,发起请求前会调用这个函数,依次传递key value…
    • 提供一个函数名为buildMessage的函数,发送webSocket参数前,会调用该函数
    • buildParam 和 buildMessage 两个函数,具体描述请看下边的js代码
  • Version
    • 功能: API配置信息(Header,Query,Body,Script)的变化版本
    • 每次触发保存时会进行比较,如果有变化,则进行版本记录
    • 每个API最多记录30条
    • Use This Version: 使用当前版本
    • Clear Cache: 仅清除该API对应的版本记录
// Script 参数处理脚本
/*** 处理Query Body(json/...)的参数* @param reqNum 第几次请求* @param key key* @param value value* @param path key路径* @param desc 描述* @param type 类型* @param check 是否选中* @returns {*}*/
function buildParam(reqNum, key, value, path, desc, type, check) {console.log("build param script:", {reqNum, key, value, path, desc, type, check})return value;
}/*** 对WebSocket参数进行处理* @param message* @returns {*}*/
function buildMessage(message) {// 自定义参数处理return message;
}

API 执行结果

  • ResponseData: 单次请求结果的返回值
    • 可以通过响应字段描述功能,添加返回值的描述文档信息
  • ResponseHeader: 单次请求的响应头信息
  • 结果: 执行多次次的响应数据展示,内包含{ResponseData,ResponseHeader},仅在[全局执行次数配置]请求后展示
  • 注:如果是下载文件类型的接口,返回值会变成{fileName:“fileName”,download:点我保存}.可以通过点击[点我保存]完成文件下载

字段描述 || 响应字段描述

  • 功能: 添加Body(json) 字段描述 或者添加响应字段描述
  • 字段: 参数名 参数类型 描述
  • 其他功能:
    • [Analysis Java Document With Swagger] 按钮
      • 该按钮可以提供将Java文件转换成文档的弹框功能,该弹框支持批量上传,拖拽上传,粘贴上传,以及点击上传;
      • Java文件必须是使用Swagger（ApiMode，ApiModelProperty）注解进行描述的;
      • 如果这个Java文件中的某个属性使用的是另外一个java文件，也可以一起选择上传，同样会自动进行关联解析;
      • 使用的Java文件最好是Lombok标注的,源码内没有get set函数,(暂未支持get set函数的解析)
    • [To Body Param] 按钮
      • 该按钮只有Body-json内的字段描述下才存在
      • 作用是将字段描述转换成对应的json参数

其他使用小技巧

本地测试以及参数值修改

安装了篡改猴插件以及脚本,和开启了本地校验,以及环境域名为 127.0.0.1 或者 localhost 时,认为是本地环境

  • 本地环境测试,需要为浏览器安装篡改猴插件
  • 允许运行用户脚本;找到插件,右键选择管理扩展程序,开启允许运行用户脚本
  • 添加如下脚本
// ==UserScript==
// @name         CORS Script
// @namespace    http://tampermonkey.net/
// @version      0.1
// @description  油猴跨域脚本
// @author       fusheng.zhang
// @match        192.168.18.192/view/pc_scmp/*
// @icon         data:image/gif;base64,R0lGODlhAQABAAAAACH5BAEKAAEALAAAAAABAAEAAAICTAEAOw==
// @grant        unsafeWindow
// @grant        GM.xmlHttpRequest
// @grant        GM_xmlhttpRequest
// ==/UserScript==(function () {// 注: 修改 @match 为你自己的路径 // 支持本地测试unsafeWindow._GM_xmlHttpRequest = GM?.xmlHttpRequest || GM_xmlhttpRequest;
})

API使用文档

目录结构

按照前端的页面进行管理.或者按照功能管理.或者按照需求管理
可对一组API的使用进行详细的描述

新建/编辑

  • 可以通过API管理的功能[选择API],批量选择多个API然后使用[编辑API使用文档]生成使用文档
  • 也可以通过API使用文档的[新建子文档],关联多个API进而生成使用文档
  • 文档内容支持协同开发

注意

  • 无论通过何种方式生成使用文档,都会先通过关联的api标识,去查询这一组api共同关联的使用文档
    • 如果存在共同的使用文档,则会回显该文档,否则就是新建api文档
  • 即:一组api只能关联一个文档

Api Swagger

对Swagger 文档的解析

定时任务调度中心

定时任务调度中心

  • 支持Cron 表达式,以及RRULE规则表达式
http://www.dtcms.com/a/508107.html

相关文章：

  • 电商秒杀系统设计 Java+MySQL实现高并发库存管理与订单处理
  • 中国建设银行笔试确认网站万网域名在中国电信网站备案系统
  • 个人网站 组建长沙旅游
  • 矩阵的奇异值分解（SVD）及其在计算机图形学中的应用
  • 青海旅游的网站建设公司网站可以免费建吗
  • 镇江网站建设zjmfkj厅网站建设中标公告
  • 高光谱成像用于草地可燃物含水率估测的研究进展
  • Product Hunt 每日热榜 | 2025-10-20
  • C++STL之unordered_map，unordered_set与哈希表
  • 电商税新规下的第三方支付云账户分账解决方案
  • 【Linux指南】冯诺依曼体系结构：现代计算机的基石
  • 建站之星怎么收费WordPress首页不收录
  • 酒店网站设计方案淘宝运营培训机构
  • sm2025 模拟赛24 (2025.10.20)
  • 【完整源码+数据集+部署教程】【后勤＆运输集装箱】集装箱表面腐蚀检测系统源码＆数据集全套：改进yolo11-swintransformer
  • 20.哈希
  • 公司网站表达的内容wordpress怎么上传高清图片大小
  • 慧聪网网站建设策略用腾讯云做淘宝客网站视频
  • XSS_and_Mysql_file靶场攻略
  • 引领交易革命：一站式去中心化交易所Swap开发一体化方案
  • 多样化的网站建设公司张雪峰谈工业设计专业
  • Houdini UV节点uvunwrap 和 uvproject和uvtexture 有什么区别
  • Vue3 条件语句详解
  • CAN总线: 位同步，接收方数据采样
  • 解决host.robots.ox.ac.uk打不开无法下载voc2007和voc2012问题
  • SQL入门：正则表达式-高效文本匹配全攻略
  • 个体制作网站设计高端创意网站建设
  • 舟山网站建设代理如何创立个人网站
  • Linux 服务器运维之 Nginx 案例化培训教程
  • 企业级SQL审核工具PawSQL介绍（1） - 六大核心能力