23.3K ·GitHub
What is this?
A collection of guidelines published by Microsoft for designing consistent, well-behaved RESTful web APIs, shared publicly to foster dialogue in the broader API community.
A collection of guidelines published by Microsoft for designing consistent, well-behaved RESTful web APIs, shared publicly to foster dialogue in the broader API community.Is this a coding library or just a document?It is a written style guide made of markdown documents, not a library or piece of software — there is nothing to install or import into a project.
It is a written style guide made of markdown documents, not a library or piece of software — there is nothing to install or import into a project.How do I actually use these guidelines?Read through the documents in the repo and apply the recommended API design patterns when designing or reviewing your own REST API; there is no installation or setup involved.
Read through the documents in the repo and apply the recommended API design patterns when designing or reviewing your own REST API; there is no installation or setup involved.Does this apply the same way to every Microsoft team?No. Azure service teams are directed to a separate companion document, the Azure REST API Guidelines and Considerations for Service Design, instead of the general ones here.
No. Azure service teams are directed to a separate companion document, the Azure REST API Guidelines and Considerations for Service Design, instead of the general ones here.Who is this guidance written for?Primarily Microsoft's own API-building teams, but it is published openly so any organization or developer can read, learn from, or adapt it for their own API standards.
Primarily Microsoft's own API-building teams, but it is published openly so any organization or developer can read, learn from, or adapt it for their own API standards.Why did Microsoft make these guidelines public?To encourage dialogue and learning across the API community, and to inspire other organizations to publish their own API design guidelines.
To encourage dialogue and learning across the API community, and to inspire other organizations to publish their own API design guidelines.Is there separate guidance for Microsoft Graph APIs?Yes, Graph teams should follow the dedicated Microsoft Graph REST API Guidelines and its associated pattern catalog instead of the general document.
Yes, Graph teams should follow the dedicated Microsoft Graph REST API Guidelines and its associated pattern catalog instead of the general document.Where do Azure teams find their specific guidance?In the Azure folder of this repository, whose own README points to the Azure REST API Guidelines and service design considerations.
In the Azure folder of this repository, whose own README points to the Azure REST API Guidelines and service design considerations.What are similar projects?styleguide, nodebestpractices, CppCoreGuidelines, angular-styleguide, es6features, project-guidelines, naming-cheatsheet, swift-style-guide
styleguide, nodebestpractices, CppCoreGuidelines, angular-styleguide, es6features, project-guidelines, naming-cheatsheet, swift-style-guideWhich topics is it in?styleguide, guidelines, api-documentation, standards, style-guide, specification, cheatsheet, architecture, best-practices, enterprise, http, reference
styleguide, guidelines, api-documentation, standards, style-guide, specification, cheatsheet, architecture, best-practices, enterprise, http, reference