postman+xxl-job
时间: 2024-12-30 20:30:57 浏览: 11
### 使用 Postman 测试 XXL-JOB API 接口
对于希望利用 Postman 来测试或调试 XXL-JOB 的 API 接口,可以按照如下方法操作:
#### 配置环境变量
在 Postman 中设置必要的环境变量来简化不同环境下 URL 和其他参数的切换。这些可能包括但不限于服务器 IP 地址、端口号以及认证令牌。
#### 认证配置
确保已获取到用于访问 XXL-JOB Admin 控制台的有效用户名和密码。通过发送 POST 请求至 `/login` 路径完成身份验证过程,并保存返回的身份验证 Token 以便后续请求使用[^4]。
```json
{
"userName": "your_username",
"password": "your_password"
}
```
成功响应会提供一个 `token` 字段,在之后向受保护资源发起请求时需将其作为头部信息的一部分携带过去。
#### 添加新任务实例
要创建一个新的调度作业条目,则可以通过调用类似于下面这样的 RESTful API 实现这一目的;此路径对应于控制器层中的相应处理函数[^3]。
```http
POST /jobinfo/add HTTP/1.1
Host: your_xxl_job_admin_host:port
Content-Type: application/json
Authorization: Bearer YOUR_ACCESS_TOKEN_HERE
{
"jobGroup": 1,
"scheduleType": "CRON",
"scheduleConf": "* * * * * ?",
"glueType": "BEAN",
"executorRouteStrategy": "FIRST",
"misfireStrategy": "DO_NOTHING",
"executorHandler": "demoJobHandler",
"author": "admin",
"description": "",
"alarmEmail": ""
}
```
上述 JSON 数据结构代表了一个完整的新增任务请求体,其中包含了关于该任务的各种属性定义。
#### 查询现有执行器列表
如果想要检索当前可用的 Executor 列表,那么应该构建 GET 类型的 HTTP 请求并指向特定 URI 模式下的 endpoint 。这有助于理解系统内部有哪些组件正在运行以及它们的状态如何。
```http
GET /jobgroup/pageList?start=0&length=10 HTTP/1.1
Host: your_xxl_job_admin_host:port
Authorization: Bearer YOUR_ACCESS_TOKEN_HERE
```
以上命令将会从数据库中提取分页后的记录集,默认情况下每页显示十条记录。
阅读全文