Проектирование APIAPI design

Большинство современных веб-приложений предоставляют API, которые клиенты могут использовать для взаимодействия с приложением.Most modern web applications expose APIs that clients can use to interact with the application. Качественно спроектированный API должен поддерживать следующее:A well-designed web API should aim to support:

  • Независимость от платформы.Platform independence. Любой клиент должен иметь возможность вызывать API, независимо от того, как API реализован внутренне.Any client should be able to call the API, regardless of how the API is implemented internally. Для этого требуется использование стандартных протоколов, а также наличие механизма, при котором клиент и веб-службы могут согласовать формат данных для обмена.This requires using standard protocols, and having a mechanism whereby the client and the web service can agree on the format of the data to exchange.

  • Развитие службы.Service evolution. Веб-API должен иметь возможность развиваться и расширять набор функций независимо от клиентских приложений.The web API should be able to evolve and add functionality independently from client applications. По мере развития API имеющиеся клиентские приложения должны продолжать работать без изменений.As the API evolves, existing client applications should continue to function without modification. Все функции должны быть доступными, чтобы клиентские приложения могли полноценно их использовать.All functionality should be discoverable so that client applications can fully use it.

В этом руководстве описываются проблемы, которые следует учитывать при разработке веб-API.This guidance describes issues that you should consider when designing a web API.

Общие сведения о RESTIntroduction to REST

В 2000 году Рой Филдинг предложил архитектурный подход к разработке веб-служб — передачу репрезентативного состояния (REST).In 2000, Roy Fielding proposed Representational State Transfer (REST) as an architectural approach to designing web services. REST — это архитектурная концепция создания распределенных систем на основе гиперсред.REST is an architectural style for building distributed systems based on hypermedia. Модель REST не зависит от каких-либо базовых протоколов и не требует привязки к HTTP.REST is independent of any underlying protocol and is not necessarily tied to HTTP. Однако наиболее распространенные реализации REST используют HTTP в качестве протокола приложения. Поэтому это руководство посвящено разработке REST API для HTTP.However, most common REST implementations use HTTP as the application protocol, and this guide focuses on designing REST APIs for HTTP.

Основное преимущество при использовании REST с протоколом HTTP заключается в применении открытых стандартов и отсутствии необходимости в определенной реализации API или клиентских приложений.A primary advantage of REST over HTTP is that it uses open standards, and does not bind the implementation of the API or the client applications to any specific implementation. Например, веб-службу REST можно написать в ASP.NET, а клиентские приложения могут использовать любой язык или набор инструментов, позволяющие создавать HTTP-запросы и анализировать HTTP-ответы.For example, a REST web service could be written in ASP.NET, and client applications can use any language or toolset that can generate HTTP requests and parse HTTP responses.

Ниже приведены некоторые основные принципы проектирования интерфейсов RESTful API, использующих протокол HTTP:Here are some of the main design principles of RESTful APIs using HTTP:

  • REST API разрабатываются на основе ресурса, который может быть любым типом объекта, данных или службы, к которому может получить доступ клиент.REST APIs are designed around resources, which are any kind of object, data, or service that can be accessed by the client.

  • У ресурса есть идентификатор (универсальный код ресурса (URI)), который уникально идентифицирует этот ресурс.A resource has an identifier, which is a URI that uniquely identifies that resource. Например, URI для определенного клиентского заказа может быть таким:For example, the URI for a particular customer order might be:

    https://adventure-works.com/orders/1
    
  • Клиенты взаимодействуют со службой путем обмена представлениями ресурсов.Clients interact with a service by exchanging representations of resources. Многие веб-API используют JSON в качества формата для обмена.Many web APIs use JSON as the exchange format. Например, в результате запроса GET к приведенному выше URI может вернуться такой текст ответа:For example, a GET request to the URI listed above might return this response body:

    {"orderId":1,"orderValue":99.90,"productId":1,"quantity":1}
    
  • Интерфейсы REST API используют единый интерфейс, который позволяет отделить реализации клиента и службы.REST APIs use a uniform interface, which helps to decouple the client and service implementations. Для REST API, созданных на основе протокола HTTP, единый интерфейс будет использовать стандартные HTTP-команды для выполнения операций с ресурсами.For REST APIs built on HTTP, the uniform interface includes using standard HTTP verbs to perform operations on resources. Наиболее часто выполняемые операции: GET, POST, PUT, PATCH и DELETE.The most common operations are GET, POST, PUT, PATCH, and DELETE.

  • REST API использует модель запросов без отслеживания состояния.REST APIs use a stateless request model. HTTP-запросы должны быть независимыми и могут создаваться в любом порядке, поэтому сохранение сведений о переходном состоянии между запросами не представляется возможным.HTTP requests should be independent and may occur in any order, so keeping transient state information between requests is not feasible. Сведения хранятся только в самих ресурсах, и каждый запрос должен быть атомарной операцией.The only place where information is stored is in the resources themselves, and each request should be an atomic operation. Благодаря этому ограничению веб-службы имеют высокую масштабируемость, так как нет необходимости сохранять сходство между клиентами и конкретными серверами.This constraint enables web services to be highly scalable, because there is no need to retain any affinity between clients and specific servers. Каждый сервер может обрабатывать любой запрос от любого клиента.Any server can handle any request from any client. Тем не менее, другие факторы могут ограничить масштабируемость.That said, other factors can limit scalability. Например, многие веб-службы ведут запись в серверное хранилище данных, которое может быть трудно развернуть. Дополнительные сведения о стратегии для развертывания хранилища данных, см. в разделе секционирование данных горизонтальной, вертикальной и функциональной.For example, many web services write to a backend data store, which may be hard to scale out. For more information about strategies to scale out a data store, see Horizontal, vertical, and functional data partitioning.

  • Интерфейсами REST API управляют ссылки на гиперсреды, которые содержатся в представлении.REST APIs are driven by hypermedia links that are contained in the representation. Например, ниже показано JSON-представление заказа.For example, the following shows a JSON representation of an order. Оно содержит ссылки для получения или обновления клиента, связанного с заказом.It contains links to get or update the customer associated with the order.

    {
        "orderID":3,
        "productID":2,
        "quantity":4,
        "orderValue":16.60,
        "links": [
            {"rel":"product","href":"https://adventure-works.com/customers/3", "action":"GET" },
            {"rel":"product","href":"https://adventure-works.com/customers/3", "action":"PUT" }
        ]
    }
    

В 2008 году Леонард Ричардсон предложил следующую модель зрелости для веб-API:In 2008, Leonard Richardson proposed the following maturity model for web APIs:

  • Уровень 0. Определение одного URI, и все операции будут POST-запросами к этому URI.Level 0: Define one URI, and all operations are POST requests to this URI.
  • Уровень 1. Создание отдельных URI для отдельных ресурсов.Level 1: Create separate URIs for individual resources.
  • Уровень 2. Использование методов HTTP для определения операций с ресурсами.Level 2: Use HTTP methods to define operations on resources.
  • Уровень 3. Использование гиперсред (HATEOAS, описан ниже).Level 3: Use hypermedia (HATEOAS, described below).

Уровень 3 соответствует настоящему RESTful API, согласно определению Филдинга.Level 3 corresponds to a truly RESTful API according to Fielding's definition. На практике многие опубликованные веб-API находятся где-то около уровня 2.In practice, many published web APIs fall somewhere around level 2.

Упорядочивание API вокруг ресурсовOrganize the API around resources

Сосредоточьтесь на бизнес-сущностях, предоставляемых веб-API.Focus on the business entities that the web API exposes. Например, в системе электронной коммерции основными сущностями могут быть клиенты и заказы.For example, in an e-commerce system, the primary entities might be customers and orders. Создание заказа может осуществляться путем отправки HTTP-запроса POST, содержащего сведения о заказе.Creating an order can be achieved by sending an HTTP POST request that contains the order information. HTTP-ответ указывает на успешность размещения заказа.The HTTP response indicates whether the order was placed successfully or not. Когда это возможно, универсальные коды ресурсов должны основываться на существительных (ресурсе), а не на глаголах (операциях c ресурсом).When possible, resource URIs should be based on nouns (the resource) and not verbs (the operations on the resource).

https://adventure-works.com/orders // Good

https://adventure-works.com/create-order // Avoid

Ресурс не обязательно должен быть основан на одном физическом элементе данных.A resource doesn't have to be based on a single physical data item. Например, ресурс заказа может быть реализован внутри системы с использованием нескольких таблиц в реляционной базе данных, однако представлен в клиентском приложении как единая сущность.For example, an order resource might be implemented internally as several tables in a relational database, but presented to the client as a single entity. Избегайте создания API, которые просто отражают внутреннюю структуру базы данных.Avoid creating APIs that simply mirror the internal structure of a database. Цель REST — моделировать сущности и операции, которые приложение может выполнять в этих сущностях.The purpose of REST is to model entities and the operations that an application can perform on those entities. Внутренняя реализация должна быть скрыта от клиента.A client should not be exposed to the internal implementation.

Сущности часто группируются в коллекции (заказов, клиентов).Entities are often grouped together into collections (orders, customers). Коллекция — это отдельный ресурс из элемента в коллекции и должен иметь свой собственный URI.A collection is a separate resource from the item within the collection, and should have its own URI. Например, следующий URI может представлять коллекцию заказов:For example, the following URI might represent the collection of orders:

https://adventure-works.com/orders

В результате отправки HTTP-запроса GET на URI коллекции возвращается список элементов в коллекции.Sending an HTTP GET request to the collection URI retrieves a list of items in the collection. Каждый элемент в коллекции также имеет свой собственный универсальный код ресурса (URI).Each item in the collection also has its own unique URI. HTTP-запрос GET к URI элемента возвращает подробные сведения об этом элементе.An HTTP GET request to the item's URI returns the details of that item.

Используйте единое соглашение об именовании в универсальных кодах ресурсов.Adopt a consistent naming convention in URIs. В целом это помогает использовать существительные во множественном числе для URI, ссылающихся на коллекции.In general, it helps to use plural nouns for URIs that reference collections. Рекомендуется упорядочивать универсальные коды ресурсов для коллекций и элементов в иерархии.It's a good practice to organize URIs for collections and items into a hierarchy. Например, /customers — это путь к коллекции клиентов, а /customers/5 — путь к клиенту с идентификатором равным 5.For example, /customers is the path to the customers collection, and /customers/5 is the path to the customer with ID equal to 5. Этот подход позволяет обеспечивать простоту веб-API.This approach helps to keep the web API intuitive. Кроме того, множество платформ веб-API могут направлять запросы на основании параметризованных путей URI, поэтому можно определить маршрут для пути /customers/{id}.Also, many web API frameworks can route requests based on parameterized URI paths, so you could define a route for the path /customers/{id}.

Также следует продумать связи между разными типами ресурсов и способы предоставления этих связей.Also consider the relationships between different types of resources and how you might expose these associations. Например, /customers/5/orders может представлять все заказы для клиента 5.For example, the /customers/5/orders might represent all of the orders for customer 5. Вы также можете пойти в другом направлении и представить связь между заказом и конкретным клиентом посредством универсального кода ресурса, например /orders/99/customer.You could also go in the other direction, and represent the association from an order back to a customer with a URI such as /orders/99/customer. Однако чрезмерное расширение этой модели может вызвать трудности.However, extending this model too far can become cumbersome to implement. Более рациональное решение — предоставить ссылки с возможностью перехода на связанные ресурсы в тексте HTTP-ответа.A better solution is to provide navigable links to associated resources in the body of the HTTP response message. Этот механизм описан более подробно в разделе HATEOAS используется для включения перехода к связанным ресурсам.This mechanism is described in more detail in the section Use HATEOAS to enable navigation to related resources.

В более сложных системах очевидным решением может показаться предоставление URI, позволяющих клиенту переходить между несколькими уровнями связей, например /customers/1/orders/99/products.In more complex systems, it can be tempting to provide URIs that enable a client to navigate through several levels of relationships, such as /customers/1/orders/99/products. Однако такой уровень сложности трудно обслуживать и адаптировать в случае дальнейшего изменения связей между ресурсами.However, this level of complexity can be difficult to maintain and is inflexible if the relationships between resources change in the future. Вместо этого постарайтесь сделать URI максимально простыми.Instead, try to keep URIs relatively simple. Как только у приложения появляется ссылка на ресурс, оно может использовать эту ссылку для поиска элементов, связанных с указанным ресурсом.Once an application has a reference to a resource, it should be possible to use this reference to find items related to that resource. Предыдущий запрос можно заменить на URI /customers/1/orders, чтобы найти все заказы для клиента 1, а затем — на /orders/99/products, чтобы найти продукты в этом заказе.The preceding query can be replaced with the URI /customers/1/orders to find all the orders for customer 1, and then /orders/99/products to find the products in this order.

Совет

Старайтесь использовать универсальные коды ресурсов не сложнее collection/item/collection.Avoid requiring resource URIs more complex than collection/item/collection.

Кроме того, следует учесть, что все веб-запросы увеличивают нагрузку на веб-сервер,Another factor is that all web requests impose a load on the web server. которая растет вместе с числом запросов.The more requests, the bigger the load. Поэтому старайтесь избегать создания веб-API с множественными операциями ввода-вывода, которые предоставляют большое количество небольших ресурсов.Therefore, try to avoid "chatty" web APIs that expose a large number of small resources. Такой API может потребовать от клиентского приложения отправки нескольких запросов для поиска всех необходимых данных.Such an API may require a client application to send multiple requests to find all of the data that it requires. Вместо этого можно выполнить денормализацию данных и объединить соответствующую информацию в более крупные ресурсы, которые можно получить с помощью одного запроса.Instead, you might want to denormalize the data and combine related information into bigger resources that can be retrieved with a single request. Однако следует сохранять равновесие в этом подходе, чтобы избежать получения чрезмерного объема данных, которые не нужны клиенту.However, you need to balance this approach against the overhead of fetching data that the client doesn't need. Получение больших объектов может увеличить задержку запроса и привести к дополнительным расходам на пропускную способность.Retrieving large objects can increase the latency of a request and incur additional bandwidth costs. Дополнительные сведения об этих антишаблонах производительности см. в статье Антишаблон отправки множественных операций ввода-вывода и Антишаблон лишней выборки.For more information about these performance antipatterns, see Chatty I/O and Extraneous Fetching.

Избегайте зависимостей между веб-API и базовыми источниками данных.Avoid introducing dependencies between the web API and the underlying data sources. Например, если данные хранятся в реляционной базе данных, веб-API не требуется предоставлять каждую таблицу в виде коллекции ресурсов.For example, if your data is stored in a relational database, the web API doesn't need to expose each table as a collection of resources. Это, вероятно, будет неэффективная архитектура.In fact, that's probably a poor design. Вместо этого представьте веб-API в виде абстракции базы данных.Instead, think of the web API as an abstraction of the database. При необходимости создайте уровень сопоставления между базой данных и веб-API.If necessary, introduce a mapping layer between the database and the web API. Таким образом клиентские приложения изолированы от изменений в базовой схеме базы данных.That way, client applications are isolated from changes to the underlying database scheme.

Наконец, сопоставление каждой операции, реализованной веб-API, с конкретным источником не всегда возможно.Finally, it might not be possible to map every operation implemented by a web API to a specific resource. Такие безресурсные сценарии можно обрабатывать с помощью HTTP-запросов, вызывающих определенную функцию и возвращающих результаты в виде ответного HTTP-сообщения.You can handle such non-resource scenarios through HTTP requests that invoke a function and return the results as an HTTP response message. Например, веб-API, реализующий простые расчетные операции, такие как добавление и вычитание, может предоставить универсальные коды ресурсов (URI), представляющие эти операции в виде псевдоресурсов, и использовать строку запроса для указания требуемых параметров.For example, a web API that implements simple calculator operations such as add and subtract could provide URIs that expose these operations as pseudo resources and use the query string to specify the parameters required. Например, запрос GET к URI / add? operand1 = 99 & operand2 = 1 бы вернуть ответное сообщение с текстом, содержащим значение 100.For example, a GET request to the URI /add?operand1=99&operand2=1 would return a response message with the body containing the value 100. Однако следует использовать эти формы универсальных кодов ресурсов (URI) с осторожностью.However, only use these forms of URIs sparingly.

Определение операций с точки зрения методов HTTPDefine operations in terms of HTTP methods

Протокол HTTP определяет несколько методов, назначающих запросу семантическое значение.The HTTP protocol defines a number of methods that assign semantic meaning to a request. Ниже приведены наиболее распространенные методы HTTP, используемые большинством веб-API RESTful:The common HTTP methods used by most RESTful web APIs are:

  • GET. Возвращает представление ресурса по указанному универсальному коду ресурса (URI).GET retrieves a representation of the resource at the specified URI. Текст ответного сообщения содержит сведения о запрашиваемом ресурсе.The body of the response message contains the details of the requested resource.
  • POST. Создает новый ресурс по указанному URI.POST creates a new resource at the specified URI. Текст запроса содержит сведения о новом ресурсе.The body of the request message provides the details of the new resource. Обратите внимание, что метод POST также можно использовать для запуска операций, не относящихся непосредственно к созданию ресурсов.Note that POST can also be used to trigger operations that don't actually create resources.
  • PUT. Создает или заменяет ресурсы по указанному URI.PUT either creates or replaces the resource at the specified URI. В тексте сообщения запроса указан создаваемый или обновляемый ресурс.The body of the request message specifies the resource to be created or updated.
  • PATCH. Выполняет частичное обновление ресурса.PATCH performs a partial update of a resource. Текст запроса определяет набор изменений, применяемых к ресурсу.The request body specifies the set of changes to apply to the resource.
  • DELETE. Удаляет ресурс по указанному URI.DELETE removes the resource at the specified URI.

Результат конкретного запроса должен зависеть от того, является ли целевой ресурс коллекцией или отдельным элементом.The effect of a specific request should depend on whether the resource is a collection or an individual item. В следующей таблице перечислены общие соглашения, принятые в большинстве реализаций RESTful с помощью примера электронной коммерции.The following table summarizes the common conventions adopted by most RESTful implementations using the e-commerce example. Не все эти запросы могут быть реализованы—зависит от конкретного сценария.Not all of these requests might be implemented—it depends on the specific scenario.

РесурсResource POSTPOST GETGET PUTPUT DELETEDELETE
/customers/customers Создание нового клиентаCreate a new customer Получение всех клиентовRetrieve all customers Массовое обновление клиентовBulk update of customers Удаление всех клиентовRemove all customers
/customers/1/customers/1 ОшибкаError Получение сведений для клиента 1Retrieve the details for customer 1 Обновление сведения о клиенте 1, если он существуетUpdate the details of customer 1 if it exists Удаление клиента 1Remove customer 1
/customers/1/orders/customers/1/orders Создание нового заказа для клиента 1Create a new order for customer 1 Получение всех заказов для клиента 1Retrieve all orders for customer 1 Массовое обновление заказов для клиента 1Bulk update of orders for customer 1 Удаление всех заказов для клиента 1Remove all orders for customer 1

Различия между POST, PUT и PATCH могут запутать новичков.The differences between POST, PUT, and PATCH can be confusing.

  • Запрос POST создает ресурс.A POST request creates a resource. Сервер назначает URI для нового ресурса и возвращает этот URI клиенту.The server assigns a URI for the new resource, and returns that URI to the client. В модели REST запросы POST постоянно применяются к коллекциям.In the REST model, you frequently apply POST requests to collections. При этом новый ресурс добавляется в коллекцию.The new resource is added to the collection. Запрос POST также может использоваться для отправки данных для обработки в имеющийся ресурс без создания нового ресурса.A POST request can also be used to submit data for processing to an existing resource, without any new resource being created.

  • Запрос PUT создает ресурс или обновляет имеющийся ресурс.A PUT request creates a resource or updates an existing resource. Клиент указывает универсальный код ресурса.The client specifies the URI for the resource. Текст запроса содержит полное представление ресурса.The request body contains a complete representation of the resource. Если ресурс с таким URI уже существует, он заменяется.If a resource with this URI already exists, it is replaced. В противном случае создается новый ресурс, если сервер поддерживает это.Otherwise a new resource is created, if the server supports doing so. Запросы PUT чаще всего применяются к ресурсам, которые являются отдельными элементами, например конкретные клиенты, а не к коллекциям.PUT requests are most frequently applied to resources that are individual items, such as a specific customer, rather than collections. Сервер может поддерживать обновления, но не создание через PUT.A server might support updates but not creation via PUT. Требуется ли поддерживать создание через PUT зависит от того, может ли клиент назначать информативный URI ресурсу до его существования.Whether to support creation via PUT depends on whether the client can meaningfully assign a URI to a resource before it exists. Если нет, используйте POST для создания ресурсов, а PUT или PATCH для обновления.If not, then use POST to create resources and PUT or PATCH to update.

  • Запрос PATCH выполняет частичное обновление имеющегося ресурса.A PATCH request performs a partial update to an existing resource. Клиент указывает универсальный код ресурса.The client specifies the URI for the resource. Текст запроса определяет набор изменений, применяемых к ресурсу.The request body specifies a set of changes to apply to the resource. Это может быть более эффективно, чем использование PUT, так как клиент отправляет только изменения, а не все представление ресурса.This can be more efficient than using PUT, because the client only sends the changes, not the entire representation of the resource. С технической точки зрения PATCH также может создать новый ресурс (указав набор обновлений для ресурса "null"), если это поддерживается сервером.Technically PATCH can also create a new resource (by specifying a set of updates to a "null" resource), if the server supports this.

Запросы PUT должны быть идемпотентными.PUT requests must be idempotent. Если клиент отправляет тот же запрос PUT несколько раз, результаты всегда должны быть одинаковыми (тот же ресурс будет изменяться с теми же значениями).If a client submits the same PUT request multiple times, the results should always be the same (the same resource will be modified with the same values). Запросы POST и PATCH не будут гарантированно идемпотентными.POST and PATCH requests are not guaranteed to be idempotent.

Соответствие семантике HTTPConform to HTTP semantics

В этом разделе описываются некоторые распространенные вопросы по проектированию API, соответствующего спецификации HTTP.This section describes some typical considerations for designing an API that conforms to the HTTP specification. Однако он не охватывает все возможные детали или сценарии.However, it doesn't cover every possible detail or scenario. Если вы сомневаетесь, обратитесь к спецификациям HTTP.When in doubt, consult the HTTP specifications.

Типы мультимедиаMedia types

Как упоминалось ранее, клиенты и серверы обмениваются представлениями ресурсов.As mentioned earlier, clients and servers exchange representations of resources. Например, в тексте запроса POST содержится представление создаваемого ресурса.For example, in a POST request, the request body contains a representation of the resource to create. В тексте запроса GET содержится представление получаемого ресурса.In a GET request, the response body contains a representation of the fetched resource.

В протоколе HTTP форматы задаются с помощью типов мультимедиа, также называемых типами MIME.In the HTTP protocol, formats are specified through the use of media types, also called MIME types. Для недвоичных данных большинство веб-API поддерживают формат JSON (тип мультимедиа — application/json) и возможно XML (тип мультимедиа — application/xml).For non-binary data, most web APIs support JSON (media type = application/json) and possibly XML (media type = application/xml).

Заголовок Content-Type в запросе или ответе определяет формат представления.The Content-Type header in a request or response specifies the format of the representation. Ниже приведен пример запроса POST, который включает в себя данные JSON:Here is an example of a POST request that includes JSON data:

POST https://adventure-works.com/orders HTTP/1.1
Content-Type: application/json; charset=utf-8
Content-Length: 57

{"Id":1,"Name":"Gizmo","Category":"Widgets","Price":1.99}

Если сервер не поддерживает данный тип мультимедиа, он возвращает код состояния HTTP 415 (неподдерживаемый тип носителя).If the server doesn't support the media type, it should return HTTP status code 415 (Unsupported Media Type).

Запрос клиента может включать заголовок Accept, содержащий список типов мультимедиа, которые клиент будет принимать от сервера в ответном сообщении.A client request can include an Accept header that contains a list of media types the client will accept from the server in the response message. Например:For example:

GET https://adventure-works.com/orders/2 HTTP/1.1
Accept: application/json

Если сервер не может соответствовать ни одному из указанных типов мультимедиа, он должен вернуть код состояния HTTP 406 (неприемлемо).If the server cannot match any of the media type(s) listed, it should return HTTP status code 406 (Not Acceptable).

Методы GETGET methods

Успешное выполнение метода GET обычно возвращает код состояния HTTP 200 (ОК).A successful GET method typically returns HTTP status code 200 (OK). Если ресурс не найден, метод должен вернуть код 404 (не найдено).If the resource cannot be found, the method should return 404 (Not Found).

Методы POSTPOST methods

Если метод POST создает новый ресурс, он возвращает код состояния HTTP 201 (создано).If a POST method creates a new resource, it returns HTTP status code 201 (Created). URI нового ресурса содержится в заголовке Location ответа.The URI of the new resource is included in the Location header of the response. Текст ответа содержит представление ресурса.The response body contains a representation of the resource.

Если метод выполняет определенную обработку, но не создает новый ресурс, он может вернуть код состояния HTTP 200 и содержать результат операции в тексте ответа.If the method does some processing but does not create a new resource, the method can return HTTP status code 200 and include the result of the operation in the response body. Кроме того, при отсутствии результатов для возврата метод может вернуть код состояния HTTP 204 (нет содержимого) без текста ответа.Alternatively, if there is no result to return, the method can return HTTP status code 204 (No Content) with no response body.

Если клиент помещает недопустимые данные в запрос, сервер должен вернуть код состояния HTTP 400 (неверный запрос).If the client puts invalid data into the request, the server should return HTTP status code 400 (Bad Request). Текст ответа может содержать дополнительные сведения об ошибке или ссылку на универсальный код ресурса (URI), по которому можно получить более подробную информацию.The response body can contain additional information about the error or a link to a URI that provides more details.

Методы PUTPUT methods

Если метод PUT создает новый ресурс, он возвращает код состояния HTTP 201 (создано), как и метод POST.If a PUT method creates a new resource, it returns HTTP status code 201 (Created), as with a POST method. Если метод обновляет имеющийся ресурс, он возвращает коды состояния 200 (ОК) или 204 (нет содержимого).If the method updates an existing resource, it returns either 200 (OK) or 204 (No Content). В некоторых случаях обновить имеющийся ресурс невозможно.In some cases, it might not be possible to update an existing resource. В этом случае рассмотрите возможность возврата кода состояния HTTP 409 (конфликт).In that case, consider returning HTTP status code 409 (Conflict).

Рассмотрите возможность реализации массовых HTTP-операций PUT, поддерживающих пакетные обновления нескольких ресурсов в коллекции.Consider implementing bulk HTTP PUT operations that can batch updates to multiple resources in a collection. В запросе PUT должен быть указан универсальный код ресурса (URI) коллекции, а текст запроса должен содержать сведения о ресурсах, которые требуется изменить.The PUT request should specify the URI of the collection, and the request body should specify the details of the resources to be modified. Такой подход помогает сократить избыточность и повысить производительность.This approach can help to reduce chattiness and improve performance.

Методы PATCHPATCH methods

С помощью запроса PATCH клиент отправляет набор обновлений в имеющийся ресурс в виде документа с исправлениями.With a PATCH request, the client sends a set of updates to an existing resource, in the form of a patch document. Сервер обрабатывает документ с исправлениями, чтобы выполнить обновление.The server processes the patch document to perform the update. Документ с исправлениями не описывает весь ресурс, а только набор применяемых изменений.The patch document doesn't describe the whole resource, only a set of changes to apply. Спецификация метода PATCH (RFC 5789) не определяет конкретный формат документов с исправлениями.The specification for the PATCH method (RFC 5789) doesn't define a particular format for patch documents. Формат необходимо определить на основе типа мультимедиа в запросе.The format must be inferred from the media type in the request.

Вероятно, наиболее распространенный формат данных для веб-API — JSON.JSON is probably the most common data format for web APIs. Есть два основных формата исправлений на основе JSON, называемые исправлением JSON и исправлением со слиянием JSON.There are two main JSON-based patch formats, called JSON patch and JSON merge patch.

Исправление со слиянием JSON несколько проще.JSON merge patch is somewhat simpler. Документ с исправлениями имеет ту же структуру, что и исходный ресурс JSON, однако включает только подмножество полей, которые необходимо изменить или добавить.The patch document has the same structure as the original JSON resource, but includes just the subset of fields that should be changed or added. Кроме того, поле можно удалить, указав null для значения поля в документе с исправлениями.In addition, a field can be deleted by specifying null for the field value in the patch document. (Это означает, что исправление со слиянием не подходит, если исходный ресурс может иметь явные значения null.)(That means merge patch is not suitable if the original resource can have explicit null values.)

Предположим, что исходный ресурс имеет следующее представление JSON:For example, suppose the original resource has the following JSON representation:

{
    "name":"gizmo",
    "category":"widgets",
    "color":"blue",
    "price":10
}

Вот возможное исправление со слиянием JSON для этого ресурса:Here is a possible JSON merge patch for this resource:

{
    "price":12,
    "color":null,
    "size":"small"
}

Это указывает серверу обновить price, удалить colorи добавьте size, хотя name и category не изменяются.This tells the server to update price, delete color, and add size, while name and category are not modified. Точные сведения об исправлении со слиянием JSON см. в документе RFC 7396.For the exact details of JSON merge patch, see RFC 7396. Тип носителя для исправления со слиянием JSON — application/merge-patch+json.The media type for JSON merge patch is application/merge-patch+json.

Исправление со слиянием не подходит, если исходный ресурс может содержать явные значения null, из-за смысла значения null в документе с исправлениями.Merge patch is not suitable if the original resource can contain explicit null values, due to the special meaning of null in the patch document. Кроме того, в документе с исправлениями не указывается порядок, в котором сервер должен применять обновления.Also, the patch document doesn't specify the order that the server should apply the updates. Это может иметь значение, в зависимости от данных и предметной области.That may or may not matter, depending on the data and the domain. Исправление JSON, определенное в RFC 6902, — более гибкое.JSON patch, defined in RFC 6902, is more flexible. Оно определяет изменения как последовательность выполняемых операций,It specifies the changes as a sequence of operations to apply. в частности добавление, удаление, замена, копирование и тестирование (для проверки значений).Operations include add, remove, replace, copy, and test (to validate values). Тип носителя для исправления JSON — application/json-patch+json.The media type for JSON patch is application/json-patch+json.

Ниже приведены некоторые типичные ошибки, которые могут возникнуть при обработке запроса PATCH, вместе с соответствующим кодом состояния HTTP.Here are some typical error conditions that might be encountered when processing a PATCH request, along with the appropriate HTTP status code.

Условие ошибкиError condition HTTP status code (Код состояния HTTP)HTTP status code
Формат документа с исправлениями не поддерживается.The patch document format isn't supported. 415 (неподдерживаемый тип носителя)415 (Unsupported Media Type)
Неправильный формат документа с исправлениями.Malformed patch document. 400 (недопустимый запрос)400 (Bad Request)
Документ с исправлениями действителен, но изменения нельзя применить к ресурсу в его текущем состоянии.The patch document is valid, but the changes can't be applied to the resource in its current state. 409 (конфликт)409 (Conflict)

Методы DELETEDELETE methods

Если операция удаления прошла успешно, веб-сервер должен вернуть ответ с кодом состояния HTTP 204, указывающим на успешное завершение процесса и отсутствие дополнительных сведений в тексте ответа.If the delete operation is successful, the web server should respond with HTTP status code 204, indicating that the process has been successfully handled, but that the response body contains no further information. Если ресурс не существует, веб-сервер может вернуть код HTTP 404 (не найдено).If the resource doesn't exist, the web server can return HTTP 404 (Not Found).

Асинхронные операцииAsynchronous operations

Иногда операцию POST, PUT, PATCH или DELETE может потребоваться обработка, которая может занять некоторое время для завершения.Sometimes a POST, PUT, PATCH, or DELETE operation might require processing that takes a while to complete. Если дожидаться завершения до отправки ответа клиенту, это может привести к неприемлемой задержке.If you wait for completion before sending a response to the client, it may cause unacceptable latency. В этом случае рассмотрите возможность создания асинхронной операции.If so, consider making the operation asynchronous. Верните код состояния HTTP 202, указывающий, что запрос был принят в обработку, но не завершен.Return HTTP status code 202 (Accepted) to indicate the request was accepted for processing but is not completed.

Следует предоставить конечную точку, которая возвращает состояние асинхронного запроса, чтобы клиент мог отслеживать состояние, опрашивая конечную точку состояния.You should expose an endpoint that returns the status of an asynchronous request, so the client can monitor the status by polling the status endpoint. Включите URI конечной точки состояния в заголовок Location ответа 202.Include the URI of the status endpoint in the Location header of the 202 response. Например:For example:

HTTP/1.1 202 Accepted
Location: /api/status/12345

Если клиент отправляет запрос GET к этой конечной точке, ответ должен содержать текущее состояние запроса.If the client sends a GET request to this endpoint, the response should contain the current status of the request. Кроме того, он также может включать предполагаемое время выполнения или ссылку для отмены операции.Optionally, it could also include an estimated time to completion or a link to cancel the operation.

HTTP/1.1 200 OK
Content-Type: application/json

{
    "status":"In progress",
    "link": { "rel":"cancel", "method":"delete", "href":"/api/status/12345" }
}

Если асинхронная операция создает новый ресурс, конечная точка состояния должна вернуть код состояния 303 (см. другие) после завершения операции.If the asynchronous operation creates a new resource, the status endpoint should return status code 303 (See Other) after the operation completes. В ответе 303 включите заголовок Location, который предоставляет URI нового ресурса:In the 303 response, include a Location header that gives the URI of the new resource:

HTTP/1.1 303 See Other
Location: /api/orders/12345

Дополнительные сведения об асинхронных операциях в REST см. в этой записи блога.For more information, see Asynchronous operations in REST.

Фильтрация и разбитие данных на страницыFilter and paginate data

Предоставление коллекции ресурсов через один универсальный код ресурса (URI) может привести к тому, что приложения будут получать крупные объемы данных, когда нужно лишь подмножество информации.Exposing a collection of resources through a single URI can lead to applications fetching large amounts of data when only a subset of the information is required. Предположим, клиентскому приложению необходимо найти все заказы с суммой выше заданного значения.For example, suppose a client application needs to find all orders with a cost over a specific value. Он может получить все заказы через универсальный код ресурса (URI) /orders, а затем отфильтровать эти заказы на стороне клиента.It might retrieve all orders from the /orders URI and then filter these orders on the client side. Очевидно, что этот процесс крайне неэффективен.Clearly this process is highly inefficient. Он впустую использует пропускную способность сети и вычислительные ресурсы сервера, на котором размещен веб-API.It wastes network bandwidth and processing power on the server hosting the web API.

Вместо этого API может разрешить передачу фильтра в строке запроса URI, например /orders?minCost=n.Instead, the API can allow passing a filter in the query string of the URI, such as /orders?minCost=n. Веб-API отвечает за синтаксический анализ и обработку параметра minCost в строке запроса и возврат отфильтрованных результатов на стороне сервера.The web API is then responsible for parsing and handling the minCost parameter in the query string and returning the filtered results on the server side.

Запросы GET по ресурсам коллекций потенциально могут возвращать большое число элементов.GET requests over collection resources can potentially return a large number of items. При проектировании веб-API следует ввести ограничение на объем данных, возвращаемый одним запросом.You should design a web API to limit the amount of data returned by any single request. Рассмотрите возможность использования строк запроса, определяющих максимальное количество элементов для получения и начальное смещение в коллекции.Consider supporting query strings that specify the maximum number of items to retrieve and a starting offset into the collection. Например:For example:

/orders?limit=25&offset=50

Также рассмотрите возможность наложения верхнего предела на количество возвращаемых элементов, чтобы предотвратить атаки типа "отказ в обслуживании".Also consider imposing an upper limit on the number of items returned, to help prevent Denial of Service attacks. Для поддержки клиентских приложений запросы GET, возвращающие разбитые по страницам данные, должны также включать какие-либо метаданные, указывающие общее число ресурсов, доступных в коллекции.To assist client applications, GET requests that return paginated data should also include some form of metadata that indicate the total number of resources available in the collection.

Аналогичную стратегию для сортировки данных можно также применить при их получении. Вы можете указать параметр сортировки, использующий имя поля в качестве значения, например /orders?sort=ProductID.You can use a similar strategy to sort data as it is fetched, by providing a sort parameter that takes a field name as the value, such as /orders?sort=ProductID. Однако такой подход может негативно отразиться на кэшировании (так как параметры строки запроса составляют часть идентификатора ресурса, используемого многими реализациями кэша в качестве ключа к кэшированным данным).However, this approach can have a negative effect on caching, because query string parameters form part of the resource identifier used by many cache implementations as the key to cached data.

Вы можете расширить этот подход и ограничить возвращаемые поля для каждого элемента, если каждый элемент содержит большой объем данных.You can extend this approach to limit the fields returned for each item, if each item contains a large amount of data. Например, используйте параметр строки запроса, принимающий разделенный запятыми список полей, например /orders?fields=ProductID,Quantity.For example, you could use a query string parameter that accepts a comma-delimited list of fields, such as /orders?fields=ProductID,Quantity.

Присвойте содержательные значения по умолчанию всем необязательным параметрам в строках запроса.Give all optional parameters in query strings meaningful defaults. Например, установите параметру limit значение 10, а параметру offset — 0, если вы реализуете разбиение по страницам, параметру сортировки в качестве значения задайте ключ ресурса, если вы реализуете упорядочение, а в параметре fields укажите все поля в ресурсе при поддержке проекций.For example, set the limit parameter to 10 and the offset parameter to 0 if you implement pagination, set the sort parameter to the key of the resource if you implement ordering, and set the fields parameter to all fields in the resource if you support projections.

Поддержка частичных ответов для больших двоичных ресурсовSupport partial responses for large binary resources

Ресурс может содержать большие двоичные поля, такие как файлы или изображения.A resource may contain large binary fields, such as files or images. Чтобы преодолеть проблемы, вызванные ненадежными и прерывистыми соединениями, а также улучшить время отклика, можно реализовать получение таких ресурсов пофрагментно.To overcome problems caused by unreliable and intermittent connections and to improve response times, consider enabling such resources to be retrieved in chunks. Для этого веб-API должен поддерживать заголовок Accept-Ranges для запросов GET по большим ресурсам.To do this, the web API should support the Accept-Ranges header for GET requests for large resources. Этот заголовок указывает, что операция GET поддерживает частичные запросы.This header indicates that the GET operation supports partial requests. Клиентское приложение может отправлять запросы GET, которые возвращают подмножество ресурса, указанное в виде диапазона байтов.The client application can submit GET requests that return a subset of a resource, specified as a range of bytes.

Кроме того, рассмотрите возможность применения HTTP-запросов HEAD для этих ресурсов.Also, consider implementing HTTP HEAD requests for these resources. Запрос HEAD аналогичен запросу GET с тем исключением, что он возвращает только заголовок HTTP, описывающий ресурс, и пустое сообщение.A HEAD request is similar to a GET request, except that it only returns the HTTP headers that describe the resource, with an empty message body. Клиентское приложение может отправить запрос HEAD, чтобы определить необходимость получения ресурса с помощью частичных запросов GET.A client application can issue a HEAD request to determine whether to fetch a resource by using partial GET requests. Например:For example:

HEAD https://adventure-works.com/products/10?fields=productImage HTTP/1.1

Вот пример сообщения ответа:Here is an example response message:

HTTP/1.1 200 OK

Accept-Ranges: bytes
Content-Type: image/jpeg
Content-Length: 4580

Заголовок Content-Length содержит общий размер ресурса, а заголовок Accept-Ranges указывает, что соответствующая операция GET поддерживает частичные результаты.The Content-Length header gives the total size of the resource, and the Accept-Ranges header indicates that the corresponding GET operation supports partial results. Клиентское приложение может использовать эту информацию для получения изображения небольшими фрагментами.The client application can use this information to retrieve the image in smaller chunks. Первый запрос возвращает первые 2500 байт с помощью заголовка "Range":The first request fetches the first 2500 bytes by using the Range header:

GET https://adventure-works.com/products/10?fields=productImage HTTP/1.1
Range: bytes=0-2499

Ответное сообщение указывает, что это частичный ответ, возвращая код состояния HTTP 206.The response message indicates that this is a partial response by returning HTTP status code 206. Заголовок "Content-Length" указывает фактическое число возвращаемых байтов в тексте сообщения (не размер ресурса), а заголовок "Content-Range" указывает, какая это часть ресурса (байты 0–2499 из 4580):The Content-Length header specifies the actual number of bytes returned in the message body (not the size of the resource), and the Content-Range header indicates which part of the resource this is (bytes 0-2499 out of 4580):

HTTP/1.1 206 Partial Content

Accept-Ranges: bytes
Content-Type: image/jpeg
Content-Length: 2500
Content-Range: bytes 0-2499/4580

[...]

Последующий запрос от клиентского приложения может получить оставшуюся часть ресурса.A subsequent request from the client application can retrieve the remainder of the resource.

Одна из основных целей реализации модели REST — получение возможности перемещаться внутри всего набора ресурсов без предварительного знания схемы универсальных кодов ресурсов (URI).One of the primary motivations behind REST is that it should be possible to navigate the entire set of resources without requiring prior knowledge of the URI scheme. Каждый HTTP-запрос GET должен возвращать сведения, необходимые для поиска ресурсов, напрямую связанных с запрашиваемым объектом, посредством гиперссылок, включенных в ответ. Запросу GET также необходимо предоставить сведения, описывающие операции, доступные в каждом из этих ресурсов.Each HTTP GET request should return the information necessary to find the resources related directly to the requested object through hyperlinks included in the response, and it should also be provided with information that describes the operations available on each of these resources. Этот принцип называется HATEOAS (гипертекст как обработчик состояния приложения).This principle is known as HATEOAS, or Hypertext as the Engine of Application State. Система фактически представляет собой конечный автомат. Ответ по каждому запросу содержит сведения, необходимые для перемещения между состояниями. Другие сведения не требуются.The system is effectively a finite state machine, and the response to each request contains the information necessary to move from one state to another; no other information should be necessary.

Примечание

На сегодняшний день не существует стандартов или спецификаций, определяющих правила моделирования принципа HATEOAS.Currently there are no standards or specifications that define how to model the HATEOAS principle. Примеры в этом разделе демонстрируют одно из возможных решений.The examples shown in this section illustrate one possible solution.

Например, чтобы обрабатывать связь между заказом и клиентом, представление заказа может включать ссылки, которые идентифицируют доступные операции для отправителя заказа.For example, to handle the relationship between an order and a customer, the representation of an order could include links that identify the available operations for the customer of the order. Вот возможное представление:Here is a possible representation:

{
  "orderID":3,
  "productID":2,
  "quantity":4,
  "orderValue":16.60,
  "links":[
    {
      "rel":"customer",
      "href":"https://adventure-works.com/customers/3",
      "action":"GET",
      "types":["text/xml","application/json"]
    },
    {
      "rel":"customer",
      "href":"https://adventure-works.com/customers/3",
      "action":"PUT",
      "types":["application/x-www-form-urlencoded"]
    },
    {
      "rel":"customer",
      "href":"https://adventure-works.com/customers/3",
      "action":"DELETE",
      "types":[]
    },
    {
      "rel":"self",
      "href":"https://adventure-works.com/orders/3",
      "action":"GET",
      "types":["text/xml","application/json"]
    },
    {
      "rel":"self",
      "href":"https://adventure-works.com/orders/3",
      "action":"PUT",
      "types":["application/x-www-form-urlencoded"]
    },
    {
      "rel":"self",
      "href":"https://adventure-works.com/orders/3",
      "action":"DELETE",
      "types":[]
    }]
}

В этом примере в массиве links есть набор ссылок.In this example, the links array has a set of links. Каждая ссылка представляет операцию в связанной сущности.Each link represents an operation on a related entity. Данные для каждой ссылки включают связь ("customer"), URI (https://adventure-works.com/customers/3), метод HTTP и поддерживаемые типы MIME.The data for each link includes the relationship ("customer"), the URI (https://adventure-works.com/customers/3), the HTTP method, and the supported MIME types. Это все данные, необходимые клиентскому приложению, чтобы иметь возможность вызова операции.This is all the information that a client application needs to be able to invoke the operation.

Массив links также включает автореферентные сведения, относящиеся к полученному ресурсу.The links array also includes self-referencing information about the resource itself that has been retrieved. Они имеют отношение self.These have the relationship self.

Набор возвращаемых ссылок может изменяться в зависимости от состояния ресурса.The set of links that are returned may change, depending on the state of the resource. Вот почему гипертекст является "обработчиком состояния приложения".This is what is meant by hypertext being the "engine of application state."

Управление версиями веб-API RESTfulVersioning a RESTful web API

Маловероятно, что веб-API останется статичным.It is highly unlikely that a web API will remain static. По мере изменения бизнес-требований добавляются новые коллекции ресурсов, изменяются связи между ресурсами и структура данных в ресурсах.As business requirements change new collections of resources may be added, the relationships between resources might change, and the structure of the data in resources might be amended. Несмотря на то что обновление веб-API для соответствия новым или измененным требованиям — довольно простой процесс, вам необходимо учесть, какое воздействие эти изменения окажут на клиентские приложения, использующие веб-API.While updating a web API to handle new or differing requirements is a relatively straightforward process, you must consider the effects that such changes will have on client applications consuming the web API. Проблема заключается в том, что несмотря на то, что разработчик, разрабатывающий и реализации веб-API имеет полный контроль над этим API, разработчик имеет такую же степень контроля над клиентскими приложениями, которые порой создаются сторонними организациями, работающими в удаленном режиме.The issue is that although the developer designing and implementing a web API has full control over that API, the developer does not have the same degree of control over client applications, which may be built by third-party organizations operating remotely. В первую очередь необходимо позволить существующим клиентским приложениям продолжать работу без изменений, при этом предоставляя новым клиентским приложениям доступ к новым функциям и ресурсам.The primary imperative is to enable existing client applications to continue functioning unchanged while allowing new client applications to take advantage of new features and resources.

Управление версиями позволяет веб-API указывать предоставляемые функции и ресурсы, за счет чего клиентское приложение может отправлять запросы для определенной версии функции или ресурса.Versioning enables a web API to indicate the features and resources that it exposes, and a client application can submit requests that are directed to a specific version of a feature or resource. В следующих разделах описано несколько различных подходов со своими преимуществами и недостатками.The following sections describe several different approaches, each of which has its own benefits and trade-offs.

Отсутствие управления версиямиNo versioning

Эта простейший подход, приемлемый для некоторых внутренних API.This is the simplest approach, and may be acceptable for some internal APIs. Значительные изменения можно представлять как новые ресурсы или ссылок.Significant changes could be represented as new resources or new links. Добавление содержимого к существующим ресурсам может не всегда является значительным изменением как клиентские приложения, которые больше не ожидаются, чтобы увидеть, что это содержимое будет игнорировать его.Adding content to existing resources might not present a breaking change as client applications that are not expecting to see this content will ignore it.

Например, запрос на универсальный код ресурса (URI) https://adventure-works.com/customers/3 должен вернуть сведения одного клиента с полями id, name и address, которые ожидает клиентское приложение.For example, a request to the URI https://adventure-works.com/customers/3 should return the details of a single customer containing id, name, and address fields expected by the client application:

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{"id":3,"name":"Contoso LLC","address":"1 Microsoft Way Redmond WA 98053"}

Примечание

Для простоты примеры ответов в этом разделе не содержат ссылок HATEOAS.For simplicity, the example responses shown in this section do not include HATEOAS links.

Если поле DateCreated добавить в схему ресурса клиента, ответ будет выглядеть следующим образом:If the DateCreated field is added to the schema of the customer resource, then the response would look like this:

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{"id":3,"name":"Contoso LLC","dateCreated":"2014-09-04T12:11:38.0376089Z","address":"1 Microsoft Way Redmond WA 98053"}

Существующие клиентские приложения могут продолжить работать без ошибок, если они могут пропускать нераспознанные поля, в то время как при проектировании новых клиентских приложений можно обеспечить поддержку новых полей.Existing client applications might continue functioning correctly if they are capable of ignoring unrecognized fields, while new client applications can be designed to handle this new field. Однако внесение более серьезных изменений в схему ресурсов (таких как удаление или переименование полей) или изменение связей между ресурсами могут быть значительными изменениями, мешающими корректной работе существующих клиентских приложений.However, if more radical changes to the schema of resources occur (such as removing or renaming fields) or the relationships between resources change then these may constitute breaking changes that prevent existing client applications from functioning correctly. В таких ситуациях следует использовать один из следующих подходов.In these situations, you should consider one of the following approaches.

Управление версиями через универсальные коды ресурсов (URI)URI versioning

При каждом изменении веб-API или схемы ресурсов вы добавляете номер версии в универсальный код (URI) каждого ресурса.Each time you modify the web API or change the schema of resources, you add a version number to the URI for each resource. Уже существующие универсальные коды ресурсов (URI) должны продолжить функционировать без изменений, возвращая ресурсы, соответствующие их исходной схеме.The previously existing URIs should continue to operate as before, returning resources that conform to their original schema.

Расширим предыдущий пример, в том случае, если address поле реструктуризации в дополнительных полей, содержащий каждую составную часть адреса (такие как streetAddress, city, state, и zipCode), эта версия ресурса может быть предоставляются посредством URI с номером версии, такие как https://adventure-works.com/v2/customers/3:Extending the previous example, if the address field is restructured into subfields containing each constituent part of the address (such as streetAddress, city, state, and zipCode), this version of the resource could be exposed through a URI containing a version number, such as https://adventure-works.com/v2/customers/3:

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{"id":3,"name":"Contoso LLC","dateCreated":"2014-09-04T12:11:38.0376089Z","address":{"streetAddress":"1 Microsoft Way","city":"Redmond","state":"WA","zipCode":98053}}

Этот механизм управления версиями очень прост, но для него требуется, чтобы сервер направлял запрос к соответствующей конечной точке.This versioning mechanism is very simple but depends on the server routing the request to the appropriate endpoint. Однако этот подход может стать чрезмерно сложным по мере прохождения веб-API через несколько итераций и необходимости поддержки сервером нескольких различных версий.However, it can become unwieldy as the web API matures through several iterations and the server has to support a number of different versions. Кроме того, c пуристической точки зрения, во всех случаях клиентские приложения получают одни и те же данные (клиент 3), поэтому универсальный код ресурса (URI) фактически не должен отличаться в зависимости от версии.Also, from a purist’s point of view, in all cases the client applications are fetching the same data (customer 3), so the URI should not really be different depending on the version. Эта схема также усложняет реализацию HATEOAS, поскольку потребуется включать номер версии в универсальные коды ресурсов (URI) всех ссылок.This scheme also complicates implementation of HATEOAS as all links will need to include the version number in their URIs.

Управление версиями через строку запросаQuery string versioning

Чтобы не указывать множество кодов URI, вы можете указать версию ресурса с помощью параметра в строке запроса, добавленного к HTTP-запросу, например https://adventure-works.com/customers/3?version=2.Rather than providing multiple URIs, you can specify the version of the resource by using a parameter within the query string appended to the HTTP request, such as https://adventure-works.com/customers/3?version=2. Значение по умолчанию параметра версии должно быть содержательным, например 1, если оно опускается клиентскими приложениями прежних версий.The version parameter should default to a meaningful value such as 1 if it is omitted by older client applications.

Этот подход обладает семантическим преимуществом в том плане, что один и тот же ресурс всегда возвращается по одинаковому универсальному коду ресурса (URI). Однако он зависит от кода, обрабатывающего запрос для анализа строки запроса и возврата соответствующего HTTP-ответа.This approach has the semantic advantage that the same resource is always retrieved from the same URI, but it depends on the code that handles the request to parse the query string and send back the appropriate HTTP response. Кроме того, этот подход также усложняет реализацию HATEOAS, как и механизм управления версиями через универсальные коды ресурсов (URI).This approach also suffers from the same complications for implementing HATEOAS as the URI versioning mechanism.

Примечание

Некоторые браузеры прежних версий и веб-прокси не могут кэшировать ответы по запросам, содержащим строку запроса в URL-адресе.Some older web browsers and web proxies will not cache responses for requests that include a query string in the URI. Это может привести к снижению производительности для веб-приложений, которые используют веб-API и выполняемых через такой веб-браузер.This can degrade performance for web applications that use a web API and that run from within such a web browser.

Управление версиями через заголовокHeader versioning

Вместо того чтобы добавлять номер версии в виде параметра строки запроса, вы можете реализовать пользовательский заголовок, указывающий версию ресурса.Rather than appending the version number as a query string parameter, you could implement a custom header that indicates the version of the resource. Этот подход требует от клиентского приложения добавления соответствующего заголовка во все запросы. При этом в коде, обрабатывающем запрос клиентского приложения, можно использовать значение по умолчанию (версия 1), если заголовок с номером версии опускается.This approach requires that the client application adds the appropriate header to any requests, although the code handling the client request could use a default value (version 1) if the version header is omitted. В следующих примерах используется пользовательский заголовок с именем Custom-Header.The following examples use a custom header named Custom-Header. Значение этого заголовка указывает версию веб-API.The value of this header indicates the version of web API.

Версия 1:Version 1:

GET https://adventure-works.com/customers/3 HTTP/1.1
Custom-Header: api-version=1
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{"id":3,"name":"Contoso LLC","address":"1 Microsoft Way Redmond WA 98053"}

Версия 2:Version 2:

GET https://adventure-works.com/customers/3 HTTP/1.1
Custom-Header: api-version=2
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{"id":3,"name":"Contoso LLC","dateCreated":"2014-09-04T12:11:38.0376089Z","address":{"streetAddress":"1 Microsoft Way","city":"Redmond","state":"WA","zipCode":98053}}

Как и в двух предыдущих подходах, реализации HATEOAS потребуется включать соответствующий пользовательский заголовок во все ссылки.As with the previous two approaches, implementing HATEOAS requires including the appropriate custom header in any links.

Управление версиями через тип носителяMedia type versioning

При отправке HTTP-запроса GET на веб-сервер клиентское приложение должно указывать поддерживаемый формат содержимого с помощью заголовка "Accept", как описано ранее в этом руководстве.When a client application sends an HTTP GET request to a web server it should stipulate the format of the content that it can handle by using an Accept header, as described earlier in this guidance. Нередко заголовок Accept используется для того, чтобы позволить клиентскому приложению указать требуемый формат текста ответа: XML, JSON или другой формат, который клиентское приложение может анализировать.Frequently the purpose of the Accept header is to allow the client application to specify whether the body of the response should be XML, JSON, or some other common format that the client can parse. Однако можно определить пользовательские типы носителей, которые содержат сведения, позволяющие клиентскому приложению указывать предпочтительную версию ресурса.However, it is possible to define custom media types that include information enabling the client application to indicate which version of a resource it is expecting. В следующем примере показан запрос, в котором используется заголовок Accept со значением application/vnd.adventure-works.v1+json.The following example shows a request that specifies an Accept header with the value application/vnd.adventure-works.v1+json. Элемент vnd.adventure-works.v1 указывает веб-серверу на необходимость возврата ресурса версии 1, в то время как элемент json указывает JSON в качестве предпочтительного формата текста ответа.The vnd.adventure-works.v1 element indicates to the web server that it should return version 1 of the resource, while the json element specifies that the format of the response body should be JSON:

GET https://adventure-works.com/customers/3 HTTP/1.1
Accept: application/vnd.adventure-works.v1+json

Код, обрабатывающий запрос, отвечает за обработку заголовка Accept и максимальное выполнение содержащихся в нем требований (клиентское приложение может указать в заголовке Accept несколько форматов, в случае чего веб-сервер может выбрать наиболее подходящий формат текста ответа).The code handling the request is responsible for processing the Accept header and honoring it as far as possible (the client application may specify multiple formats in the Accept header, in which case the web server can choose the most appropriate format for the response body). Веб-сервер подтверждает формат данных в тексте ответа с помощью заголовка "Content-Type":The web server confirms the format of the data in the response body by using the Content-Type header:

HTTP/1.1 200 OK
Content-Type: application/vnd.adventure-works.v1+json; charset=utf-8

{"id":3,"name":"Contoso LLC","address":"1 Microsoft Way Redmond WA 98053"}

Если в заголовке "Accept" не указан ни один из известных типов носителя, веб-сервер может отправить ответное сообщение с кодом HTTP 406 (неприемлемо) или вернуть сообщение с типом носителя по умолчанию.If the Accept header does not specify any known media types, the web server could generate an HTTP 406 (Not Acceptable) response message or return a message with a default media type.

Вероятно, это самый полноценный механизм управления версиями, беспрепятственно поддерживающий принцип HATEOAS, который может включать MIME-тип связанных данных в ссылках ресурсов.This approach is arguably the purest of the versioning mechanisms and lends itself naturally to HATEOAS, which can include the MIME type of related data in resource links.

Примечание

При выборе стратегии управления версиями вам также следует учесть воздействие на производительность, особенно при кэшировании на веб-сервере.When you select a versioning strategy, you should also consider the implications on performance, especially caching on the web server. Управление версиями через универсальные коды ресурсов (URI) и строку запроса поддерживает кэширование, поскольку одинаковое сочетание универсального кода ресурса (URI) и строки запроса каждый раз соотносится с одними и теми же данными.The URI versioning and Query String versioning schemes are cache-friendly inasmuch as the same URI/query string combination refers to the same data each time.

Механизмы управления версиями через заголовок и тип носителя, как правило, требуют дополнительной логики для проверки значений в пользовательском заголовке или заголовке "Accept".The Header versioning and Media Type versioning mechanisms typically require additional logic to examine the values in the custom header or the Accept header. Использование многочисленными клиентами разных версий веб-API в крупномасштабной среде может привести к образованию большого объема повторяющихся данных в кэше на стороне сервера.In a large-scale environment, many clients using different versions of a web API can result in a significant amount of duplicated data in a server-side cache. Эта проблема может усложниться, если клиентское приложение обменивается данными с веб-сервером через прокси-сервер, реализующий кэширование, который перенаправляет запрос на веб-сервер лишь в том случае, если в его кэше на текущий момент не содержится копия запрашиваемых данных.This issue can become acute if a client application communicates with a web server through a proxy that implements caching, and that only forwards a request to the web server if it does not currently hold a copy of the requested data in its cache.

Open API InitiativeOpen API Initiative

Организация Open API Initiative создана отраслевым консорциумом для стандартизации описаний REST API разных поставщиков.The Open API Initiative was created by an industry consortium to standardize REST API descriptions across vendors. В рамках этой инициативы спецификация Swagger 2.0 была переименована в OpenAPI Specification (OAS) и перенесена в проект Open API Initiative.As part of this initiative, the Swagger 2.0 specification was renamed the OpenAPI Specification (OAS) and brought under the Open API Initiative.

Возможно, вам потребуется применить OpenAPI для вашего веб-API.You may want to adopt OpenAPI for your web APIs. Учитывайте следующие факторы.Some points to consider:

  • Спецификация OpenAPI поставляется с набором заключений и рекомендаций по разработке REST API.The OpenAPI Specification comes with a set of opinionated guidelines on how a REST API should be designed. Она дает ряд преимуществ для взаимодействия, но требует дополнительного внимания при разработке API для соблюдения спецификации.That has advantages for interoperability, but requires more care when designing your API to conform to the specification.

  • В OpenAPI рекомендуется начинать работу с создания контракта, а не реализации.OpenAPI promotes a contract-first approach, rather than an implementation-first approach. Это означает, что при разработке API вы сначала создаете контракт (интерфейс) и лишь после этого пишете код для его реализации.Contract-first means you design the API contract (the interface) first and then write code that implements the contract.

  • При помощи Swagger и других средства можно создавать клиентские библиотеки и документацию на основе контрактов API.Tools like Swagger can generate client libraries or documentation from API contracts. Например, см. в разделе страницы справки веб-API ASP.NET с использованием Swagger.For example, see ASP.NET Web API help pages using Swagger.

Дополнительные сведенияMore information