23.3K ·GitHub
Что это такое?
Набор руководств, опубликованных Microsoft для проектирования единообразных и корректно работающих веб-API в стиле RESTful. Они открыты для всех, чтобы поддержать диалог в широком сообществе разработчиков API.
Набор руководств, опубликованных Microsoft для проектирования единообразных и корректно работающих веб-API в стиле RESTful. Они открыты для всех, чтобы поддержать диалог в широком сообществе разработчиков API.Это библиотека для кода или просто документ?Это письменное руководство по стилю, состоящее из документов в формате Markdown, а не библиотека и не программное обеспечение — ничего не нужно устанавливать или подключать к проекту.
Это письменное руководство по стилю, состоящее из документов в формате Markdown, а не библиотека и не программное обеспечение — ничего не нужно устанавливать или подключать к проекту.Как мне на самом деле пользоваться этими руководствами?Прочитайте документы в репозитории и применяйте рекомендованные шаблоны проектирования API при создании или проверке собственного REST API; никакой установки или настройки не требуется.
Прочитайте документы в репозитории и применяйте рекомендованные шаблоны проектирования API при создании или проверке собственного REST API; никакой установки или настройки не требуется.Одинаково ли это применяется ко всем командам Microsoft?Нет. Командам, работающим с сервисами Azure, рекомендуется использовать отдельный сопутствующий документ — Azure REST API Guidelines and Considerations for Service Design — вместо общих рекомендаций отсюда.
Нет. Командам, работающим с сервисами Azure, рекомендуется использовать отдельный сопутствующий документ — Azure REST API Guidelines and Considerations for Service Design — вместо общих рекомендаций отсюда.Для кого написаны эти рекомендации?В первую очередь для собственных команд Microsoft, которые создают API, но они опубликованы в открытом доступе, чтобы любая организация или разработчик мог читать их, учиться на них или адаптировать под свои стандарты API.
В первую очередь для собственных команд Microsoft, которые создают API, но они опубликованы в открытом доступе, чтобы любая организация или разработчик мог читать их, учиться на них или адаптировать под свои стандарты API.Зачем Microsoft сделала эти руководства публичными?Чтобы поощрить диалог и обмен знаниями в сообществе разработчиков API и побудить другие организации публиковать собственные руководства по проектированию API.
Чтобы поощрить диалог и обмен знаниями в сообществе разработчиков API и побудить другие организации публиковать собственные руководства по проектированию API.Есть ли отдельные рекомендации для Microsoft Graph API?Да, командам Graph следует руководствоваться специальным документом Microsoft Graph REST API Guidelines и связанным с ним каталогом шаблонов, а не общим документом.
Да, командам Graph следует руководствоваться специальным документом Microsoft Graph REST API Guidelines и связанным с ним каталогом шаблонов, а не общим документом.Где командам Azure найти свои специфические рекомендации?В папке Azure этого репозитория — в её собственном README есть ссылки на Azure REST API Guidelines и рекомендации по проектированию сервисов.
В папке Azure этого репозитория — в её собственном README есть ссылки на Azure REST API Guidelines и рекомендации по проектированию сервисов.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