Index of every page on this site: llms.txt
All skills
jeremylongshore avatar

/validating-api-responses

@820dfc8
Run it yourself

Validate API responses against schemas to ensure contract compliance and data integrity. Use when ensuring API response correctness. Trigger with phrases like "validate responses", "check API responses", or "verify response format".

Use this Skill: https://skilld.dev/gh/jeremylongshore/tons-of-skills-marketplace/validating-api-responses

Nothing lands on disk. Nothing to clean up.

Fork this Skill

Edit a local copy. It keeps the author and licence.

SKILL.md

≈65 tokens for metadata: the name and description. ≈1.2k when used: this file. ≈2.1k more on demand in 3 files.

Description uses 3.2% of example budget

Before choosing a Skill, your Agent reads its name and description. All available Skills share that space.

  • A shorter description leaves more room for other Skills. This entry exceeds our 1% size suggestion.

In our Claude Code example, all Skill names and descriptions share 8,000 characters. This Skill uses ≈259 characters, or 3.2%.

The 1% threshold is a size suggestion. Longer descriptions can still fit.

Your model, settings, and other Skills decide how much text your Agent can read.

Example settings and source

The example uses a 200k-token context and default Claude Code settings. The count includes the name, description, separators, and when_to_use when present. Codex also counts local file paths.

Skit's source and limits: Codex 0.160.1, Claude Code 2.1.292.

Validating API Responses

Overview

Validate API responses against OpenAPI schemas, JSON Schema definitions, and contract specifications to detect data integrity violations, schema drift, and backward compatibility regressions. Run validation in middleware (development/staging) or as post-deployment contract tests to ensure every response conforms to the documented API contract.

Prerequisites

  • OpenAPI 3.0+ specification with complete response schema definitions for all endpoints
  • JSON Schema validator: Ajv (Node.js), jsonschema (Python), or everit-org/json-schema (Java)
  • Response validation middleware or test harness integrated into CI pipeline
  • API test client for exercising endpoints and capturing response bodies
  • Schema diff tool for detecting contract changes between versions

Instructions

  1. Read the OpenAPI specification using Read and extract all response schemas per endpoint, including success responses (200, 201), error responses (400, 404, 500), and header definitions.
  2. Compile JSON Schema validators for each endpoint-status combination, enabling strict mode (additionalProperties: false) to detect undocumented fields leaking into responses.
  3. Implement response validation middleware that intercepts outgoing responses and validates the body against the corresponding schema, logging violations without blocking responses in production.
  4. Configure validation strictness per environment: strict (fail on violation) in development/staging, warn (log only) in production, with violation metrics emitted for monitoring.
  5. Add header validation to verify required response headers (Content-Type, Cache-Control, rate limit headers) match the OpenAPI specification.
  6. Build a contract test suite that sends representative requests to each endpoint and validates every response field, including nested objects, arrays, enums, nullable fields, and format constraints (date-time, email, URI).
  7. Implement schema drift detection that compares the current response shape against the documented schema after each deployment, alerting when undocumented fields appear or documented fields disappear.
  8. Generate a validation coverage report showing which endpoints and response codes have schema validation, identifying gaps in the specification.

See references/implementation.md for the full implementation guide.

Output

  • ${CLAUDE_SKILL_DIR}/src/middleware/response-validator.js - Response schema validation middleware
  • ${CLAUDE_SKILL_DIR}/src/validators/ - Compiled JSON Schema validators per endpoint
  • ${CLAUDE_SKILL_DIR}/tests/contract/ - Contract test suite validating all endpoint responses
  • ${CLAUDE_SKILL_DIR}/reports/validation-coverage.md - Schema coverage report per endpoint and status code
  • ${CLAUDE_SKILL_DIR}/reports/schema-drift.json - Detected undocumented response field changes
  • ${CLAUDE_SKILL_DIR}/src/config/validation.js - Per-environment validation strictness configuration

Error Handling

Error Cause Solution
Additional property detected Response contains field not defined in schema Add field to schema if intentional; remove from serializer if data leak; configure additionalProperties
Type mismatch Field returns string instead of documented integer (or vice versa) Fix serializer to match schema type; add type coercion test; check ORM field mapping
Required field missing Response omits a field marked required in schema Verify database query includes the field; check conditional serialization logic
Null value on non-nullable Field returns null but schema does not include nullable: true Update schema to allow null, or fix data source to guarantee non-null values
Format validation failure Date field does not match RFC 3339 format or email field format invalid Apply format serialization at the ORM/model level before response construction

Refer to references/errors.md for comprehensive error patterns.

Examples

CI contract gate: On every pull request, run contract tests that validate all endpoint responses against the OpenAPI spec, failing the build if any response violates the documented schema.

Production response sampling: In production, validate 5% of responses against schemas (sampled randomly), emitting response_validation_failure metrics to detect schema drift caused by data changes.

Backward compatibility check: Compare v1 and v2 response schemas to verify that v2 is a superset of v1 (no removed fields, no type changes), ensuring existing consumers are not broken.

See references/examples.md for additional examples.

Resources

Source: SKILL.md on GitHub

skilld matched fixed text patterns in SKILL.md and file names. Patterns miss obfuscated code.

skilld run checks every file with the same patterns. It asks for approval before it loads a Skill with a behavior marked Needs approval.

No alerts2mo3 checks · Risk SAFE
  • Gen Agent Trust Hub2mo

    This skill provides a comprehensive framework for validating API responses against OpenAPI and JSON schemas. It utilizes industry-standard tools and patterns for ensuring data integrity and contract compliance in development and production environments.

  • Socket2mo

    No alerts

  • Snyk2mo

    Risk: LOW · No issues

Signed by skilld at 820dfc8. This ties the file your Agent reads to that commit on GitHub. It does not review the instructions.

Last checked against GitHub 20 hours ago.

Activeupdated last month
What it can do
Reads files Edits files Runs commands
version
1.25.0
author
Jeremy Longshore <jeremy@intentsolutions.io>
tags
[
  "api",
  "compliance",
  "validating-api"
]
All 6 allowed tools
ReadWriteEditGrepGlobBash(api:validate-*)
Other metadata
compatibility
Designed for Claude Code

README badge

README badge for jeremylongshore/tons-of-skills-marketplace/validating-api-responses