API Endpoints

Test API Documentation

GET /api/test-api

Quick Examples

// Default JSON response
/api/test-api

// HTML response with delay
/api/test-api?type=html&delay=2000

// Error response with custom status
/api/test-api?type=error&status=404

// XML response
/api/test-api?type=xml

// Plain text response
/api/test-api?type=text

Parameters

Parameter	Type	Description	Default
type	string	Response type (json, text, html, xml, error)	json
status	number	HTTP status code	200
delay	number	Response delay in milliseconds	0

Response

{
  "message": "GET request successful",
  "timestamp": "2024-01-01T00:00:00.000Z",
  "method": "GET",
  "query": {},
  "headers": {}
}

POST /api/test-api

Quick Examples

// Basic POST request
/api/test-api

// With validation enabled
/api/test-api?validate=true

Parameters

Parameter	Type	Description	Default
validate	boolean	Enable request validation (requires name and email fields)	false

Response

{
  "message": "POST request successful",
  "receivedData": { /* your request body */ },
  "timestamp": "2024-01-01T00:00:00.000Z",
  "method": "POST",
  "headers": {}
}

PUT /api/test-api

Quick Examples

// Default (1s delay)
/api/test-api

// Custom delay (3s)
/api/test-api?delay=3000

Parameters

Parameter	Type	Description	Default
delay	number	Processing delay in milliseconds	1000

Response

{
  "message": "PUT request successful",
  "receivedData": { /* your request body */ },
  "timestamp": "2024-01-01T00:00:00.000Z",
  "method": "PUT",
  "processingTime": "1000ms"
}

DELETE /api/test-api

Quick Examples

// Successful deletion
/api/test-api?id=123

// Not found error
/api/test-api?id=123&status=notfound

// Simulated error
/api/test-api?id=123&status=error

Parameters

Parameter	Type	Description	Required
id	string	Resource ID to delete	Yes
status	string	Simulate scenarios (error, notfound)	No

Response

{
  "message": "DELETE request successful",
  "timestamp": "2024-01-01T00:00:00.000Z",
  "method": "DELETE",
  "deletedId": "123"
}

PATCH /api/test-api

Quick Examples

// Default mode
/api/test-api

// Validation mode
/api/test-api?mode=validate

// Partial update mode
/api/test-api?mode=partial

// Error simulation
/api/test-api?mode=error

Parameters

Parameter	Type	Description	Default
mode	string	Update mode (default, validate, partial, error)	default

Response

{
  "message": "PATCH request successful",
  "receivedData": { /* your request body */ },
  "timestamp": "2024-01-01T00:00:00.000Z",
  "method": "PATCH",
  "mode": "default"
}

HEAD /api/test-api

Quick Examples

// Default headers
/api/test-api

// Cache headers
/api/test-api?scenario=cache

// CORS headers
/api/test-api?scenario=cors

// Custom headers
/api/test-api?scenario=custom

Parameters

Parameter	Type	Description	Default
scenario	string	Header scenario (default, cache, cors, custom)	default

Response Headers

{
  "X-Test-Header": "test-value",
  "X-Timestamp": "2024-01-01T00:00:00.000Z"
}

OPTIONS /api/test-api

Quick Examples

// Default OPTIONS response
/api/test-api

// With CORS headers
/api/test-api?cors=true

Parameters

Parameter	Type	Description	Default
cors	boolean	Include CORS headers	false

Response Headers

{
  "Allow": "GET, POST, PUT, DELETE, PATCH, HEAD, OPTIONS",
  "Access-Control-Allow-Methods": "GET, POST, PUT, DELETE, PATCH, HEAD, OPTIONS",
  "Access-Control-Allow-Headers": "Content-Type, Authorization, X-Requested-With"
}