backend-test

Validate NestJS backend API endpoints using curl commands.

1|Updated Nov 12, 2024
One-click install
npx skills add https://github.com/ak125/nestjs-remix-monorepo --skill backend-test-ak125
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: backend-test
Source: https://github.com/ak125/nestjs-remix-monorepo/tree/main/.claude/skills/backend-test
Command: npx skills add https://github.com/ak125/nestjs-remix-monorepo --skill backend-test-ak125

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) components.

What problem does it solve?

This Skill automates the testing of your NestJS backend API, ensuring endpoints function correctly, data structures are valid, and performance meets expectations.

Core Features & Use Cases

  • Endpoint Verification: Test individual API endpoints using curl for status codes, response structure, and data integrity.
  • Health Checks: Quickly verify the backend server is running and responsive.
  • Regression Testing: Define a checklist of tests to run after code changes to prevent regressions.
  • Performance Baselines: Monitor response times and payload sizes to ensure optimal performance.

Quick Start

Run a health check on the backend API by executing the command to check the health endpoint.

Frequently Asked Questions about backend-test

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

FAQPage Schema
How do I test NestJS backend API endpoints using curl?

To test NestJS backend API endpoints using curl, you execute targeted commands for health checks, smoke tests, and endpoint verification. This validates status codes, response structures, and data integrity across modules like auth and payments.

What is regression testing for NestJS APIs and when do I need it?

Regression testing for NestJS APIs defines a checklist of tests to run after code changes to prevent regressions. You need this process to verify existing module-specific endpoint functionality, database state validation, and performance baselines remain intact.

Can I measure API performance baselines and response times with curl?

Yes, you can measure API performance baselines with curl by monitoring response times and payload sizes. This ensures your NestJS endpoints maintain optimal performance during smoke tests and regression testing workflows.

Does this backend testing approach support module-specific endpoint verification?

Yes, this backend testing approach supports module-specific endpoint verification for catalog, search, auth, and payments modules. It applies specific patterns for response validation and identifies common failure modes within these distinct NestJS components.

What is the best way to structure a backend testing workflow for NestJS?

The best way to structure a backend testing workflow for NestJS is to define sequential phases for setup, testing, and reporting. This includes executing health checks, verifying database state, and validating response structures against expected patterns.