integra-api-conventions

Name: integra-api-conventions
Availability: InStock
Author: Integra

Define and enforce HTTP API conventions for headers, status codes, and JSON payloads.

Updated Aug 23, 2026

Search Tags:#api #rest #json #conventions #http #headers

Ready to run

npx skills add https://github.com/Integra-Beauty/integra-conventions --skill integra-api-conventions

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: integra-api-conventions
Source: https://github.com/Integra-Beauty/integra-conventions/tree/main/skills/integra-api-conventions
Command: npx skills add https://github.com/Integra-Beauty/integra-conventions --skill integra-api-conventions

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This guide helps teams design and enforce consistent HTTP API conventions to improve reliability, interoperability, and developer experience across services.

Core Features & Use Cases

Consistent Content-Type handling and correct status codes for REST APIs.
Standardized header practices including prefixed custom headers and lowercase access patterns.
JSON property naming in snake_case and URL paths in lowercase with clear delimiting.
Guidance on request/response structure, pagination, and safe error messaging to avoid data leakage.
Real-world reference by example API handler patterns and a centralized reference repository.

Quick Start

Start applying the conventions when designing a new HTTP API endpoint by aligning headers, status codes, and JSON payloads to the rules outlined above.

Frequently Asked Questions about integra-api-conventions

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

FAQPage Schema

What are standard HTTP API conventions for REST endpoints?▼

Standard HTTP API conventions enforce consistent Content-Type handling, correct status codes, lowercase URL paths, snake_case JSON properties, and X-prefixed custom headers to improve service reliability and interoperability.

How do I structure JSON payloads and headers for consistent REST API design?▼

Structure JSON payloads using snake_case property naming and send headers using lowercase access patterns with X-prefixed custom headers. This standardized request and response structure ensures clear delimiting across REST APIs.

What is the best way to handle pagination and error messaging in HTTP APIs?▼

The best way to handle pagination and error messaging in HTTP APIs is to follow specific guidance on payload pagination and use safe error messaging practices that prevent accidental data leakage during endpoint failures.

Can I use these API conventions for serverless endpoints?▼

Yes, you can apply these HTTP API conventions to serverless endpoints. The guidelines specify consistent rules for headers, status codes, and payload structure that apply across both traditional REST APIs and serverless architectures.

Why do my custom HTTP headers cause interoperability issues?▼

Custom HTTP headers cause interoperability issues when they are not properly prefixed. Enforcing X-prefixed custom headers and lowercase access patterns standardizes header practices and prevents conflicts across different services.

When should I enforce URL casing and JSON naming rules in API development?▼

You should enforce URL casing and JSON naming rules when designing any new HTTP API endpoint. Aligning URLs to lowercase and JSON properties to snake_case from the start ensures consistent payload structure and reliable integration.