Microsoft REST API Guidelines is a style guide and reference collection for designing REST APIs.
The guidelines address the problem of inconsistency across API design by establishing a shared set of conventions and best practices. The approach works by documenting patterns, naming conventions, error handling strategies, and structural recommendations that teams can apply when building or modifying REST services. The guidelines are published openly to encourage dialogue within the API community and to inspire other organizations to develop and share their own standards.
Teams building Azure services should reference the Azure REST API Guidelines and Considerations for Service Design documents, which provide guidance tailored specifically to Azure service requirements. Teams working on Microsoft Graph services should consult the Microsoft Graph REST API Guidelines and its associated pattern catalog. The tool suits organizations that want to establish consistency across multiple API teams or that are building services within the Microsoft ecosystem. It is most valuable for teams that need to align with either Azure or Graph service standards, though the general Microsoft REST API Guidelines may inform design decisions more broadly.
The project maintains a repository of documents and related materials supporting the guidelines initiative and welcomes contributions through its established contribution guidelines. The tool is positioned as a reference resource rather than an automated enforcement mechanism, relying on teams to apply the documented patterns during their design and development processes.
