api-test

Automate end-to-end API testing for local backend services with curl.

2|Updated May 2, 2025
One-click install
npx skills add https://github.com/adryanev/.dotfiles --skill api-test-adryanev
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: api-test
Source: https://github.com/adryanev/.dotfiles/tree/main/.agents/skills/api-test
Command: npx skills add https://github.com/adryanev/.dotfiles --skill api-test-adryanev

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Automates end-to-end API testing for local backend services by starting the server if needed and validating endpoints with curl, producing a Test Execution Document (TED) in docs/reports/.

Core Features & Use Cases

  • Autonomous server lifecycle management: starts, monitors, and cleans up the local service as needed.
  • Sequential endpoint testing: validates each endpoint with curl and captures complete responses for TED generation.
  • TED generation: creates a comprehensive Test Execution Document saved under docs/reports/.

Quick Start

Start the backend service if needed, run the API tests sequentially using curl, and generate a TED in docs/reports/.

Frequently Asked Questions about api-test

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I automate end-to-end API testing for a local backend service?

You can automate end-to-end API testing by starting the local server if needed and validating endpoints sequentially with curl, capturing complete responses to verify health, auth, and response formats without manual intervention.

What is a Test Execution Document and how is it generated from API tests?

A Test Execution Document (TED) is a comprehensive report generated in docs/reports/ that captures complete curl responses and validation results from sequential endpoint tests, providing structured documentation of your API testing execution.

How do I discover API endpoints from OpenAPI specs during local testing?

Discover API endpoints by parsing OpenAPI specs or source routes directly during local development, allowing the testing process to identify and validate available endpoints automatically before running sequential curl checks.

Can I run API health checks without manually starting the local server?

Yes, API health checks can run without manual server startup because the testing process autonomously manages the server lifecycle, starting, monitoring, and cleaning up the local backend service as needed before validating endpoints.

Does this API testing approach work with curl for validating auth and response formats?

Yes, this approach uses curl to validate endpoint authentication and response formats sequentially, capturing complete HTTP responses during local backend testing to ensure endpoints behave correctly and meet expected format requirements.

What's the best way to verify local backend endpoints during development?

The best way to verify local backend endpoints during development is to automate sequential curl-based tests that handle server lifecycle management, perform health checks, and generate a structured Test Execution Document in docs/reports/.