TopRank Skills

Home / Claw Skills / API Integration / api-endpoint-tester
Official OpenClaw rules 36%

api-endpoint-tester

CLI tool to test REST API endpoints with various HTTP methods, headers, and payloads.

Stars

0

Installs

0

Status

ACTIVE

Visibility

PUBLIC

安装方式

直接复制以下提示词,发送给你的 AI 助手即可完成安装。

请先检查是否已安装 SkillHub 商店,若未安装,请根据 https://skillhub-1388575217.cos.ap-guangzhou.myqcloud.com/install/skillhub.md 安装 SkillHub 商店,然后安装 api-endpoint-tester 技能。 若已安装,则直接安装 api-endpoint-tester 技能。

Overview

Skill Key
derick001/api-endpoint-tester
Author
skill-factory
Source Repo
openclaw/skills
Version
1.0.0
Source Path
skills/derick001/api-endpoint-tester
Latest Commit SHA
1b95c192c2334a7526a787634894c313328f3543

Extracted Content

SKILL.md excerpt

# API Endpoint Tester

## What This Does

A simple CLI tool to send HTTP requests to REST API endpoints and validate responses. Supports GET, POST, PUT, DELETE, PATCH methods with custom headers and request bodies (JSON or form data).

## When To Use

- You need to test API endpoints manually or in scripts
- You want to validate HTTP status codes and response formats
- You're debugging API integrations and need quick requests
- You need to check if an endpoint is reachable and responding correctly

## Usage

Basic GET request:
python3 scripts/main.py run --url "https://api.example.com/users" --method GET

POST with JSON body:
python3 scripts/main.py run --url "https://api.example.com/users" --method POST --body '{"name": "John", "email": "john@example.com"}'

With custom headers:
python3 scripts/main.py run --url "https://api.example.com/users" --method GET --headers '{"Authorization": "Bearer token123"}'

## Examples

### Example 1: Simple GET request

```bash
python3 scripts/main.py run --url "https://jsonplaceholder.typicode.com/posts/1" --method GET
```

Output:
```json
{
  "status": "success",
  "status_code": 200,
  "headers": {
    "content-type": "application/json; charset=utf-8"
  },
  "body": {
    "userId": 1,
    "id": 1,
    "title": "sunt aut facere repellat provident occaecati excepturi optio reprehenderit",
    "body": "quia et suscipit\nsuscipit recusandae consequuntur expedita et cum\nreprehenderit molestiae ut ut quas totam\nnostrum rerum est autem sunt rem eveniet architecto"
  },
  "response_time_ms": 245
}
```

### Example 2: POST with validation

```bash
python3 scripts/main.py run --url "https://jsonplaceholder.typicode.com/posts" --method POST --body '{"title": "foo", "body": "bar", "userId": 1}' --expected-status 201
```

## Requirements

- Python 3.x
- `requests` library (install via pip if not available)

## Limitations

- This is a CLI tool, not an auto-integration plugin
- Does not support WebSocket or streaming endpoints
- Limited to H...

README excerpt

# API Endpoint Tester

A command-line tool for testing REST API endpoints with various HTTP methods, headers, and payloads.

## Installation

This skill requires Python 3.x and the `requests` library.

```bash
pip install requests
```

## Quick Start

```bash
# Basic GET request
python3 scripts/main.py run --url "https://jsonplaceholder.typicode.com/posts/1" --method GET

# POST with JSON body
python3 scripts/main.py run --url "https://jsonplaceholder.typicode.com/posts" --method POST --body '{"title": "test", "body": "content"}'

# With custom headers
python3 scripts/main.py run --url "https://api.example.com/data" --method GET --headers '{"Authorization": "Bearer token123", "User-Agent": "MyApp"}'
```

## Command Reference

```
python3 scripts/main.py run [OPTIONS]
```

Options:
- `--url`: Target URL (required)
- `--method`: HTTP method (GET, POST, PUT, DELETE, PATCH, HEAD, OPTIONS). Default: GET
- `--headers`: JSON string of headers. Default: {}
- `--body`: Request body (JSON or form data). Default: null
- `--timeout`: Request timeout in seconds. Default: 10
- `--expected-status`: Expected HTTP status code. If provided, will check against actual status.
- `--verify-ssl`: Verify SSL certificates. Default: true
- `--allow-redirects`: Follow redirects. Default: true
- `--output-file`: Save response to file (optional)

## Response Format

The tool returns a JSON object with the following structure:

```json
{
  "status": "success" | "error",
  "error_message": "Description if status is error",
  "status_code": 200,
  "headers": {},
  "body": {},
  "response_time_ms": 123,
  "url": "https://example.com",
  "method": "GET"
}
```

## Examples

### Basic GET Request

```bash
python3 scripts/main.py run --url "https://jsonplaceholder.typicode.com/posts/1"
```

### POST with JSON Body

```bash
python3 scripts/main.py run \
  --url "https://jsonplaceholder.typicode.com/posts" \
  --method POST \
  --body '{"title": "My Post", "body": "Content here", "userId": 1}' \
  --head...

Related Claw Skills