You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: Guidelines.md
+82-61Lines changed: 82 additions & 61 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,3 +1,13 @@
1
+
> # NOTICE TO READERS
2
+
>
3
+
> ## **Guidance for Azure service teams**
4
+
> Azure service teams should use 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.
5
+
>
6
+
> ## **Guidance for Microsoft Graph service teams**
7
+
> Graph service teams should reference the companion document, [Graph REST API Guidelines](./graph/GuidelinesGraph.md) when building or modifying their services. This document and the associated pattern catalog provides a refined set of guidance targeted specifically for Microsoft Graph services.
8
+
9
+
---
10
+
1
11
# Microsoft REST API Guidelines
2
12
3
13
## Microsoft REST API Guidelines Working Group
@@ -23,134 +33,145 @@ This document establishes the guidelines Microsoft REST APIs SHOULD follow so RE
Copy file name to clipboardExpand all lines: README.md
+13-7Lines changed: 13 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,17 +1,23 @@
1
-
# Microsoft REST API Guidelines
1
+
# NOTICE TO READERS
2
+
3
+
## Guidance for Azure service teams
4
+
Azure service teams should use 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.
5
+
6
+
## Guidance for Microsoft Graph service teams
7
+
Microsoft Graph service teams should reference the companion document, [Graph REST API Guidelines](./graph/GuidelinesGraph.md) when building or modifying their services.
8
+
9
+
In the process of building many of Microsoft's highest scale services, the Microsoft Graph team found the Microsoft API guidelines tremendously useful as a baseline. However, there are several areas where we need to provide more clarity on how developers should describe their APIs. The companion document, [Graph REST API Guidelines](./graph/GuidelinesGraph.md) is a set of amendments and clarifications for Microsoft Graph that act as further reading. Recognizing that two documents is a lot for a new API designer to absorb, our plan is to follow the approach Azure have taken and roll out guidelines for Microsoft Graph into a single consolidated document.
10
+
11
+
---
12
+
13
+
## Microsoft REST API Guidelines
2
14
The [Microsoft REST API Guidelines](Guidelines.md) are Microsoft's internal company-wide REST API design guidelines.
3
15
Teams at Microsoft typically reference this document when setting API design policy.
4
16
They may additionally create documents specific to their team, adding further guidance or making adjustments as appropriate to their circumstances.
5
17
6
18
We publish these guidelines here with the aim of fostering dialogue and learning in the API community at large.
7
19
We further hope that these guidelines may encourage other organizations to create guidelines that are appropriate for them and in turn, if they are able, to publish theirs.
8
20
9
-
### Additional guidance for Azure service teams
10
-
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.
11
-
12
-
### Additional guidance for Microsoft Graph service teams
13
-
Graph service teams should reference the companion document, [Graph REST API Guidelines](./graph/GuidelinesGraph.md) when building or modifying their services. This document and the associated pattern catalog provides a refined set of guidance targeted specifically for Microsoft Graph services.
14
-
15
21
[](https://creativecommons.org/licenses/by/4.0/)
0 commit comments