Microsoft REST API指南

1.摘要

Microsoft REST API指南作为一种设计原则，鼓励应用程序开发人员通过RESTful HTTP接口为他们提供可访问的资源。为了在遵循Microsoft REST API准则的平台上为开发人员提供最顺畅的体验，REST API应遵循一致的设计准则，以便使用它们变得简单直观。

本文档建立了Microsoft REST API应遵循的准则，以便一致地开发RESTful接口。

2.目录

Microsoft REST API准则工作组
1.摘要
2.目录
3.介绍
- 3.1推荐阅读
4.关于指南
- 4.1适用指南

3.介绍

开发人员通过HTTP接口访问大多数Microsoft Cloud Platform资源。尽管每个服务通常都提供特定于语言的框架来包装其API，但它们的所有操作最终都归结为HTTP请求。Microsoft必须支持广泛的客户端和服务，并且不能依赖于可用于每个开发环境的丰富框架。因此，这些指南的目标是确保具有基本HTTP支持的任何客户端可以更容易，统一地使用Microsoft REST API。

为了给开发人员提供最顺畅的体验，让这些API遵循一致的设计指南非常重要，这样才能使用它们变得简单直观。本文档建立了Microsoft REST API开发人员为了统一地开发此类API而应遵循的准则。

统一的好处是日积月累的: 统一之后允许团队利用通用代码，模式，文档和设计决策。

这些准则旨在实现以下目标:

为Microsoft中的所有API端点定义统一的做法和模式。
尽可能地遵守业内普遍接受的REST / HTTP最佳实践。
通过REST接口轻松访问所有应用程序开发人员的Microsoft服务。
允许服务开发人员利用其他服务的先前工作来实现，测试和记录一致定义的REST端点。
允许合作伙伴（例如，非Microsoft实体）将这些准则用于他们自己的REST端点设计。

注意：本指南旨在与符合REST架构风格的构建服务保持一致，但它们不解决或要求构建遵循REST约束的服务。本文档中使用的术语“REST”是指本着REST的精神而不是本书坚持REST的服务。

3.1. 推荐阅读

建议理解REST架构风格背后的理念，以开发良好的基于HTTP的服务。

如果您是RESTful设计的新手，这里有一些很好的资源:

REST on Wikipedia) — REST的通俗定义和核心思想概述。

REST Dissertation — Roy Fielding关于网络架构的论文“建筑风格和基于网络的软件架构设计”中的REST章节。

RFC 7231 — 定义HTTP / 1.1语义的规范，并被视为权威资料。

REST in Practice — REST的基础知识。