Вступление

Руководство по проектированию API

Вступление

Это общее руководство по проектированию API служб. За основу взят документ Google API Design Guide

Данное руководство относится как к REST API, так и к RPC API, с особым упором на API gRPC. gRPC API используют Protocol Buffers для определения их API. Функции сопоставления HTTP используются Cloud Endpoints gRPC APIs для JSON/HTTP в Protocol Buffers/RPC перекодировки .

Это руководство не является неоспоримым догматом и может быть исправлено со временем, когда будут приняты и одобрены новые стили т шаблоны дизайна. Поэтому нельзя считать его абсолютно полным, всегда будет место для улучшений и дополнений.

Соглашения, используемые в этом документе

Ключевое слово уровня требований: - «НЕОБХОДИМО», «ТРЕБУЕТСЯ», «ДОЛЖНО» - «НЕДОПУСТИМО», «НЕ ДОЛЖНО» - «СЛЕДУЕТ», «РЕКОМЕНДУЕТСЯ» - «НЕ СЛЕДУЕТ», «НЕ РЕКОМЕНДУЕТСЯ» - «ВОЗМОЖНО» - «НЕ ОБЯЗАТЕЛЬНО»

Документ должен интерпретироваться, как описано в RFC 2119 .