integra-api-conventions

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.