https://github.com/Microsoft/api-guidelines

Microsoft REST API Guidelines
https://github.com/Microsoft/api-guidelines

api guidelines rest-api styleguide

Last synced: about 2 months ago
JSON representation

Microsoft REST API Guidelines

• Host: GitHub
• URL: https://github.com/Microsoft/api-guidelines
• Owner: microsoft
• License: other
• Created: 2016-07-12T20:01:24.000Z (over 8 years ago)
• Default Branch: vNext
• Last Pushed: 2024-09-24T15:59:35.000Z (3 months ago)
• Last Synced: 2024-10-08T11:31:27.685Z (2 months ago)
• Topics: api, guidelines, rest-api, styleguide
• Homepage:
• Size: 2.35 MB
• Stars: 22,695
• Watchers: 625
• Forks: 2,712
• Open Issues: 164
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: license.txt
  • Codeowners: .github/CODEOWNERS
  • Security: SECURITY.md

Awesome Lists containing this project

• Resources - Microsoft REST API Guidelines
• starred-awesome - api-guidelines - Microsoft REST API Guidelines (Others)

README

        
# Microsoft REST API Guidelines

Thank you for your interest in the Microsoft REST API Guidelines. If you have landed here, you're probably interested in learning about APIs. If so, you are in the right place!

We publish these guidelines here with the aim of fostering dialogue and learning in the API community at large. We further hope that these guidelines might encourage other organizations to create guidelines that are appropriate for them and in turn, if they're able, to publish theirs.

### Guidance for Azure service teams

Azure service teams should reference the companion documents, [Azure REST API Guidelines](./azure/Guidelines.md) and [Considerations for Service Design](./azure/ConsiderationsForServiceDesign.md), when building or modifying their services. These documents provide a refined set of guidance targeted specifically for Azure services. For more information, please refer to the [README](./azure/README.md) in the Azure folder.

### Guidance for Microsoft Graph service teams

Graph service teams should reference the companion document, [Microsoft Graph REST API Guidelines](./graph/GuidelinesGraph.md) when building or modifying their services. This document and the associated pattern catalog provide a refined set of guidance targeted specifically for Microsoft Graph services.

[![License: CC BY 4.0](https://img.shields.io/badge/License-CC%20BY%204.0-lightgrey.svg)](https://creativecommons.org/licenses/by/4.0/)

## Code of Conduct

This project adopts the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). For more information, see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [[email protected]](mailto:[email protected]) with any additional questions or comments.

## This repository

This repository contains a collection of documents and related materials supporting the overall Microsoft REST API Guidelines initiative. To contribute to this repository, see the [contribution guidelines][contribution-guidance].

[contribution-guidance]: CONTRIBUTING.md