jsonapi

Validate API endpoints against the JSON:API v1.1 specification.

1|Updated Aug 16, 2025
One-click install
npx skills add https://github.com/professor-moody/cloud-tools --skill jsonapi-professor-moody
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: jsonapi
Source: https://github.com/professor-moody/cloud-tools/tree/main/repos/prowler/skills/jsonapi
Command: npx skills add https://github.com/professor-moody/cloud-tools --skill jsonapi-professor-moody

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill ensures your API endpoints strictly adhere to the JSON:API v1.1 specification, preventing common compliance errors and improving API interoperability.

Core Features & Use Cases

  • Specification Validation: Enforces MUST/MUST NOT rules for document structure, resource objects, relationships, and error objects.
  • HTTP Status Code Enforcement: Guarantees correct usage of HTTP status codes for various API operations.
  • Query Parameter Compliance: Validates adherence to standard query parameter formats for filtering, sorting, and pagination.
  • Use Case: When developing or reviewing a new API endpoint, use this Skill to automatically check if the response structure, error handling, and relationship definitions precisely match the JSON:API standard.

Quick Start

Use the jsonapi skill to validate the structure of an API response against the JSON:API specification.

Frequently Asked Questions about jsonapi

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

FAQPage Schema
How do I validate my API response against the JSON:API v1.1 specification?

JSON:API compliance validation checks document structure, resource object formatting, relationship definitions, and error objects against strict rules. It ensures correct HTTP status codes and standard query parameters for creating, modifying, and reviewing API responses.

What does strict JSON:API v1.1 compliance require for document structure and relationships?

Strict JSON:API v1.1 compliance enforces MUST and MUST NOT rules for document structure, resource object formatting, relationship definitions, and error objects. This prevents common compliance errors and improves API interoperability across endpoints.

How do I check if my API endpoints use correct HTTP status codes and query parameters for JSON:API?

Checking HTTP status codes and query parameters for JSON:API involves validating endpoints against the specification. This guarantees correct status code usage for operations and validates adherence to standard query parameter formats for filtering, sorting, and pagination.

When do I need to validate API endpoints for JSON:API specification compliance?

You need to validate API endpoints for JSON:API specification compliance when developing or reviewing a new API endpoint. This check ensures response structure, error handling, and relationship definitions precisely match the JSON:API standard.

Can I use this validation for filtering, sorting, and pagination query parameters in a REST API?

Yes, you can validate filtering, sorting, and pagination query parameters in a REST API by checking adherence to standard JSON:API query parameter formats. This ensures strict compliance during operations like creating and modifying API responses.

Why does my JSON:API response structure fail compliance validation?

Your JSON:API response structure fails compliance validation if it violates MUST and MUST NOT rules for document structure, resource objects, relationships, or error objects. It also fails if HTTP status codes and query parameters are used incorrectly.