api-guidelines README

The project's README from github.com/microsoft/api-guidelines. As one markdown file: README.md.

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 and Considerations for Service Design, 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 in the Azure folder.

Guidance for Microsoft Graph service teams

Graph service teams should reference the companion document, Microsoft Graph REST API Guidelines 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

Code of Conduct

This project adopts the Microsoft Open Source Code of Conduct. For more information, see the Code of Conduct FAQ or contact [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.

api-guidelines (microsoft/api-guidelines)

Searching Database…

这是什么?这是 Microsoft 发布的一套指南,用于设计一致、行为规范的 RESTful Web API,并公开分享,以促进更广泛的 API 社区交流。
这是编程库,还是只是一份文档?这是一份由 Markdown 文档组成的书面风格指南,不是库或软件,没有任何需要安装或导入项目的内容。
我到底该怎么使用这些指南?阅读仓库中的文档,在设计或审查自己的 REST API 时应用其中推荐的 API 设计模式,无需任何安装或配置。
这些规范对 Microsoft 的每个团队都一样适用吗?不一样。Azure 服务团队应参考另一份配套文档 Azure REST API Guidelines and Considerations for Service Design,而不是这里的通用指南。
这套指南主要面向谁?主要面向 Microsoft 自己的 API 开发团队,但由于是公开发布的,任何组织或开发者都可以阅读、学习,或将其改编为自己的 API 标准。
Microsoft 为什么要公开这些指南?为了促进 API 社区内的交流与学习,并激励其他组织发布自己的 API 设计指南。
Microsoft Graph API 有没有单独的指南?有。Graph 团队应遵循专门的 Microsoft Graph REST API Guidelines 及其配套的模式目录,而不是通用文档。
Azure 团队在哪里找到他们专属的指南?在本仓库的 Azure 文件夹中,其自带的 README 指向 Azure REST API Guidelines 以及服务设计相关的考量内容。
Creator
microsoft
Size
2.6 MB
Stars
23.3K
Updated
CommitAug 05
Age
10y
Commits · 90 Days