Standards
Explore integration and API standards, documentation guidelines, and linting rules to ensure consistency, quality, and governance across APIs and integrations.
API & Integration Standards
These standards define the recommended practices, governance rules, and documentation requirements for designing, publishing, and maintaining APIs and integrations across the organization.
They help teams ensure consistency, improve developer experience, simplify integration processes, and maintain high quality standards across synchronous and asynchronous communication patterns.
Available Standards
Integration Standard
Guidelines and standards for enterprise integrations, communication patterns, governance, and platform usage across teams.
API Naming Standard
Naming conventions and best practices for APIs, services, resources, and endpoints to ensure consistency across platforms.
Sync API Documentation Standard
Documentation requirements and best practices for synchronous REST APIs, including examples, schemas, and governance rules.
Sync API Linting Rules
Validation and linting rules for synchronous APIs to improve API quality, consistency, and governance compliance.
Async API Documentation Standard
Standards and best practices for documenting asynchronous APIs, events, channels, and message contracts.
Async API Linting Rules
Validation and linting rules for asynchronous APIs and event-driven integrations. Documentation will be available soon.
Why Standards Matter
Why should teams follow API standards?
What is the purpose of linting rules?
Do these standards apply to both sync and async APIs?