Dragonfly API is a canonical API definition repository that serves as the source of truth for Dragonfly service interfaces and their mocks.
The repository addresses the need for a centralized, authoritative location where API contracts for Dragonfly services are defined and maintained. It uses Protocol Buffers and gRPC to specify service interfaces, ensuring consistency across all components that depend on these APIs. By housing API definitions separately from implementation, the project enables multiple Dragonfly services to evolve independently while maintaining compatibility through a shared contract.
This repository is essential for anyone contributing to the Dragonfly ecosystem or building services that integrate with it. It suits projects that need to understand or extend Dragonfly's service interfaces. Developers who need to modify API definitions should coordinate with the Dragonfly maintainers through the established channels rather than making unilateral changes, as the API serves as a dependency for multiple downstream projects.
The project maintains active community engagement through multiple channels including Slack, GitHub Discussions, and developer mailing lists. Development follows a structured contribution process with clear guidelines documented in the repository's contributing documentation and code of conduct.
